diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml index fb64720c28..346c78d6ee 100644 --- a/.buildkite/pipeline.yml +++ b/.buildkite/pipeline.yml @@ -5,7 +5,7 @@ steps: env: RUBY_VERSION: "{{ matrix.ruby }}" TEST_SUITE: "{{ matrix.suite }}" - STACK_VERSION: 8.16.0-SNAPSHOT + STACK_VERSION: 8.19.5-SNAPSHOT TRANSPORT_VERSION: "{{ matrix.transport }}" RUBY_SOURCE: "{{ matrix.ruby_source }}" QUIET: false @@ -15,12 +15,12 @@ steps: - "free" - "platinum" ruby: + - "3.4" - "3.3" - "3.2" - "3.1" - - "3.0" transport: - - "8.3" + - "8.4" ruby_source: - 'ruby' # Only run platinum once for the latest Ruby. You can use lots of combinations, check the @@ -28,29 +28,29 @@ steps: adjustments: - with: suite: "platinum" - ruby: "3.2" + ruby: "3.1" skip: true - with: suite: "platinum" - ruby: "3.1" + ruby: "3.2" skip: true - with: suite: "platinum" - ruby: "3.0" + ruby: "3.3" skip: true - with: suite: "free" - ruby: "3.3" + ruby: "3.4" ruby_source: "ruby" - transport: "8.1" + transport: "8.2" - with: suite: "free" - ruby: "3.3" + ruby: "3.4" ruby_source: "ruby" - transport: "8.2" + transport: "8.3" - with: suite: "free" - ruby: "3.3" + ruby: "3.4" ruby_source: "ruby" transport: "main" - with: @@ -66,9 +66,9 @@ steps: agents: provider: "gcp" env: - RUBY_VERSION: "3.3" - STACK_VERSION: 8.16.0-SNAPSHOT - ES_YAML_TESTS_BRANCH: main + RUBY_VERSION: "3.4" + STACK_VERSION: 8.19.5-SNAPSHOT + ES_YAML_TESTS_BRANCH: "8.19" TRANSPORT_VERSION: "8.3" RUBY_SOURCE: "ruby" TEST_SUITE: "platinum" diff --git a/.github/workflows/main.yml b/.github/workflows/8.19.yml similarity index 81% rename from .github/workflows/main.yml rename to .github/workflows/8.19.yml index 766ef5fe2c..5345bc9e2c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/8.19.yml @@ -1,11 +1,11 @@ -name: main +name: 8.19 on: push: branches: - - main + - 8.19 pull_request: branches: - - main + - 8.19 jobs: test-main: env: @@ -14,7 +14,7 @@ jobs: strategy: fail-fast: false matrix: - ruby: [ '3.0', '3.1', '3.2', '3.3', 'jruby-9.3', 'jruby-9.4' ] + ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby-9.3', 'jruby-9.4', 'jruby-10'] runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -26,7 +26,7 @@ jobs: sudo sysctl -w vm.max_map_count=262144 - uses: elastic/elastic-github-actions/elasticsearch@master with: - stack-version: 8.16.0-SNAPSHOT + stack-version: 8.19.5-SNAPSHOT security-enabled: false - uses: ruby/setup-ruby@v1 with: @@ -40,4 +40,4 @@ jobs: - name: elasticsearch run: cd elasticsearch && bundle exec rake test:all - name: elasticsearch-api - run: rake es:download_artifacts[8.16.0-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:spec test:platinum:unit + run: rake es:download_artifacts[8.19.5-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:spec test:platinum:unit diff --git a/.github/workflows/license.yml b/.github/workflows/license.yml index 8816ff40dd..e556b833ee 100644 --- a/.github/workflows/license.yml +++ b/.github/workflows/license.yml @@ -7,7 +7,7 @@ jobs: - uses: actions/checkout@v4 - uses: ruby/setup-ruby@v1 with: - ruby-version: '3.3' + ruby-version: '3.4' - name: Check license headers run: | ruby ./.github/check_license_headers.rb diff --git a/.github/workflows/otel.yml b/.github/workflows/otel.yml index 56d6b9a5fc..df609d1f3f 100644 --- a/.github/workflows/otel.yml +++ b/.github/workflows/otel.yml @@ -2,10 +2,10 @@ name: opentelemetry on: push: branches: - - main + - 8.19 pull_request: branches: - - main + - 8.19 jobs: test-otel: name: 'Test Open Telemetry' @@ -16,7 +16,7 @@ jobs: strategy: fail-fast: false matrix: - ruby: [ '3.3', 'jruby-9.4' ] + ruby: ['3.4', 'jruby-9.4'] runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -28,7 +28,7 @@ jobs: sudo sysctl -w vm.max_map_count=262144 - uses: elastic/elastic-github-actions/elasticsearch@master with: - stack-version: 8.16.0-SNAPSHOT + stack-version: 8.19.5-SNAPSHOT security-enabled: false - uses: ruby/setup-ruby@v1 with: @@ -42,4 +42,4 @@ jobs: - name: elasticsearch run: cd elasticsearch && bundle exec rake test:all - name: elasticsearch-api - run: rake es:download_artifacts[8.16.0-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:spec test:platinum:unit + run: rake es:download_artifacts[8.19.5-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:spec test:platinum:unit diff --git a/CHANGELOG.md b/CHANGELOG.md index 257dcea000..fbd08e1374 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,233 @@ *See the full release notes on the official documentation website: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/release_notes.html* +## 8.19.1 Release notes + +#### API changes + +* Updated source code documentation links to Elasticsearch documentation to 8.19 +* Adds `transform.set_upgrade_mode` - Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade. + +## 8.19.0 Release notes + +#### Client + +Tested versions of Ruby for 8.19.0: Ruby (MRI) 3.1, 3.2, 3.3, 3.4. JRuby 9.3, JRuby 9.4 and JRuby 10. + +#### API changes + +* `cluster.get_component_template` - Adds `flat_settings` boolean parameter, return settings in flat format (default: false). Adds `settings_filter` String parameter, filter out results, for example to filter out sensitive information. +* `cluster.put_component_template` - Removes `timeout` parameter, adds `cause` String parameter, used defined reason for creation. +* `create` - Adds `require_alias` and `require_data_stream` boolean parameters, to specify required type to be created. +* `eql.search` - Adds `ccs_minimize_roundtrips`, `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `esql.async_query` - Adds `allow_partial_results` boolean parameter. +* `esql.async_query_get` - Adds `format` String parameter (e.g. json, yaml). +* `esql.query` - Adds `allow_partial_results` boolean parameter. +* `indices.recovery` - Adds `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `msearch` - Adds `ignore_unavailable`, `ignore_throttled`, `allow_no_indices`, `include_named_queries_score` boolean parameters, `expand_wildcards` String parameter and `routing`, a comma-separated list of specific routing values. +* `open_point_in_time` - Adds `max_concurrent_shard_requests` parameter, the number of concurrent shard requests per node executed concurrently when opening this point-in-time +* `reindex` - Adds `require_alias` boolean parameter. +* `search_mvt` - Adds `grid_agg` String parameter, aggregation used to create a grid for `field`. +* `snapshot.repository_analyze` - Adds `register_operation_count` parameter, the minimum number of linearizable register operations to perform in total. + +Time parameters `master_timeout` and `timeout` have been added to the following APIs: + +* `index_lifecycle_management`: + * `delete_lifecycle` + * `get_lifecycle` + * `put_lifecycle` + * `start` + * `stop` + * `explain_lifecycle` - Only `master_timeout` + +* `ingest`: + * `delete_geoip_database` + * `delete_ip_location_database` + * `put_geoip_database` + * `put_ip_location_database` + +#### New APIs + +* `indices.delete_data_stream_options` - Deletes the data stream options of the selected data streams. +* `indices.get_data_stream_options` - Returns the data stream options of the selected data streams. +* `indices.get_data_stream_settings` - Gets a data stream's settings. +* `indices.put_data_stream_options` - Updates the data stream options of the selected data streams. +* `indices.put_data_stream_settings` - Updates a data stream's settings. +* `inference.put_amazonsagemaker` - Configure an Amazon SageMaker inference endpoint. +* `inference.put_custom` - Configure a custom inference endpoint. +* `inference.put_deepseek` - Configure a DeepSeek inference endpoint. + + +## 8.18.0 Release notes + +### API + +#### New APIs: + +* `esql.async_query_stop` - Stops a previously submitted async query request given its ID and collects the results. +* `inference.chat_completion_unified` - Perform chat completion inference +* `inference.completion` - Perform completion inference +* `inference.put_alibabacloud` - Configure an AlibabaCloud AI Search inference endpoint +* `inference.put_amazonbedrock` - Configure an Amazon Bedrock inference endpoint +* `inference.put_anthropic` - Configure an Anthropic inference endpoint +* `inference.put_azureaistudio` - Configure an Azure AI Studio inference endpoint +* `inference.put_azureopenai` - Configure an Azure OpenAI inference endpoint +* `inference.put_cohere` - Configure a Cohere inference endpoint +* `inference.put_elasticsearch` - Configure an Elasticsearch inference endpoint +* `inference.put_elser` - Configure an ELSER inference endpoint +* `inference.put_googleaistudio` - Configure a Google AI Studio inference endpoint +* `inference.put_googlevertexai` - Configure a Google Vertex AI inference endpoint +* `inference.put_hugging_face` - Configure a HuggingFace inference endpoint +* `inference.put_jinaai` - Configure a JinaAI inference endpoint +* `inference.put_mistral` - Configure a Mistral inference endpoint +* `inference.put_openai` - Configure an OpenAI inference endpoint +* `inference.put_voyageai` - Configure a VoyageAI inference endpoint +* `inference.put_watsonx` - Configure a Watsonx inference endpoint +* `inference.rerank` - Perform reranking inference +* `inference.sparse_embedding` - Perform sparse embedding inference +* `inference.stream_inference` renamed to `inference.stream_completion` - Perform streaming completion inference. +* `inference.text_embedding` - Perform text embedding inference + +#### Updated APIs: + +* `bulk`, `create`, `index`, `update` - Add Boolean parameter `:include_source_on_error`, if to include the document source in the error message in case of parsing errors (defaults to true). +* `cat.segments` + * Adds Boolean parameter `:local`, return local information, do not retrieve the state from master node (default: false). + * Adds Time parameter `:master_timeout`, explicit operation timeout for connection to master node. +* `cat.tasks` + * Adds Time parameter `:timeout`, period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * Adds Boolean parameter `:wait_for_completion`, if `true`, the request blocks until the task has completed. +* `eql.search` + * Adds Boolean parameter `:allow_partial_search_results`, control whether the query should keep running in case of shard failures, and return partial results. + * Adds Boolean parameter `:allow_partial_sequence_results`, control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true. +* `index_lifecycle_management.delete_lifecycle`, `index_lifecycle_management.explain_lifecycle`, `index_lifecycle_management.get_lifecycle`, `index_lifecycle_management.put_lifecycle`, `index_lifecycle_management.start`, `index_lifecycle_management.stop`, remove `:master_timeout`, `:timeout` parameters. +* `indices.resolve_cluster` - Adds `:timeout` parameter, `:name` no longer a required parameter. +* `indices.rollover` - Removes target_failure_store parameter. +* `ingest.delete_geoip_database`, `ingest.delete_ip_location_database`, `put_geoip_database`, `put_ip_location_database` remove `:master_timeout`, `:timeout` parameters. +* `machine_learning.start_trained_model_deployment` - Adds body request parameter, the settings for the trained model deployment. + + +## 8.17.2 Release notes + +### API + +#### New APIs: + +* `esql.async_query_delete` +* `indices.get_data_lifecycle_stats` +* `inference.update` +* `security.delegate_pki` + +#### Updated APIs: + +* `async_search.submit` - Adds `keep_alive` Time parameter. +* `indices.put_template` - Adds `cause` String parameter. +* `xpack.info` - Adds `human` parameter for human-readable information. +* Timeout parameters updated: + * `:master_timeout` (Time), explicit operation timeout for connection to master node. + * `:timeout` (Time), explicit operation timeout. + * Added to: + * `index_lifecycle_management.delete_lifecycle` - adds both. + * `index_lifecycle_management.delete_lifecycle` - adds `master_timeout`. + * `index_lifecycle_management.get_lifecycle` - adds both. + * `index_lifecycle_management.put_lifecycle` - adds both. + * `index_lifecycle_management.start` - adds both. + * `index_lifecycle_management.stop` - adds both. + * `ingest.delete_geoip_database` - adds both. + * `ingest.delete_geoip_location_database` - adds both. + * `ingest.put_geoip_database` - adds both. + * `ingest.put_ip_location_database` - adds both. + * `license.post_start_trial` - removes `timeout`. + * `shutdown.delete_node` - adds both. + * `shutdown.put_node` - adds both. + * `snapshot_lifecycle_management.delete_lifecycle` - adds both. + * `snapshot_lifecycle_management.execute_lifecycle` - adds both. + * `snapshot_lifecycle_management.execute_retention` - adds both. + * `snapshot_lifecycle_management.get_lifecycle` - adds both. + * `snapshot_lifecycle_management.get_stats` - adds both. + * `snapshot_lifecycle_management.get_status` - adds both. + * `snapshot_lifecycle_management.put_lifecycle` - adds both. + +#### APIs promoted from Experimental to Stable: + +* `inference.delete` +* `inference.get` +* `inference.inference` +* `inference.put` +* `inference.stream_inference` + +## 8.17.1 Release notes + +### Client + +* Fixes ScrollHelper issue #2556 - There was a bug where an additional search (with scroll) request was made to Elasticsearch for each resulting hit. It was rewritten so that the docs are retrieved as needed and the Helper instance doesn't store documents internally, with big savings in memory and requests to Elasticsearch. + +## 8.17.0 Release notes + +### Client +* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. + +### API + +#### API changes +* `async_search.submit` - Removes `keep_alive` parameter. Adds: + * `ccs_minimize_roundtrips` (Boolean): When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters. + * `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response. +* `open_point_in_time` - Adds `allow_partial_search_results` (Boolean) parameter: Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception (default: false). + + +## 8.16.0 Release notes + +### Client +* Tested versions of Ruby for 8.16.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. + +### API + +#### API changes + +* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered. +* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false) +* `indices.get_data_stream` - Adds `verbose` boolean parameter: Whether the maximum timestamp for each data stream should be calculated and returned (default: false). Adds `master_timeout` (see below). +* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter. + +##### Timeout parameters: + +These parameters have been added to several APIs: + +* `master_timeout` timeout for processing on master node. +* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. + +Added in: + +* `indices.create_data_stream` - both. +* `indices.delete_data_stream` - `master_timeout`. +* `indices.get_data_lifecycle` - `master_timeout`. +* `indices.get_data_stream` - `master_timeout`. +* `indices.migrate_to_data_stream` - both. +* `indices.promote_data_stream` - `master_timeout`. +* `search_shards` - `master_timeout`. + +#### APIs Promoted from Experimental to Stable: + +* `indices.delete_data_lifecycle` +* `indices.explain_data_lifecycle` +* `indices.get_data_lifecycle` +* `indices.put_data_lifecycle` +* `security.create_cross_cluster_api_key` +* `security.update_cross_cluster_api_key` + +#### New APIs + +* `ingest.delete_ip_location_database` - Deletes an ip location database configuration. +* `ingest.get_ip_location_database` - Returns the specified ip location database configuration. +* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded. + + +#### New Experimental APIs + +* `inference.stream_inference` - Perform streaming inference. +* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria. + + ## 8.15.0 Release notes ### Client diff --git a/Gemfile b/Gemfile index c618282910..a2263210df 100644 --- a/Gemfile +++ b/Gemfile @@ -38,5 +38,5 @@ end group :development, :test do gem 'debug' unless defined?(JRUBY_VERSION) gem 'rspec' - gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) && Gem::Version.new(JRUBY_VERSION) <= Gem::Version.new('9.4') + gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) end diff --git a/docs/release_notes/816.asciidoc b/docs/release_notes/816.asciidoc new file mode 100644 index 0000000000..c32e719f57 --- /dev/null +++ b/docs/release_notes/816.asciidoc @@ -0,0 +1,57 @@ +[[release_notes_8_16]] +=== 8.16 Release notes + +[discrete] +[[release_notes_8_16_0]] +=== 8.16.0 Release notes + +[discrete] +==== Client +* Tested versions of Ruby for 8.16.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. + +[discrete] +==== API + +[discrete] +===== API changes + +* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered. +* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false). +* `indices.get_data_stream` - Adds `verbose` boolean parameter: Whether the maximum timestamp for each data stream should be calculated and returned (default: false). Adds `master_timeout` (see below). +* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter. + +These parameters have been added to several APIs: + +* `master_timeout` timeout for processing on master node. +* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. + +Added in: + +* `indices.create_data_stream` - both. +* `indices.delete_data_stream` - `master_timeout`. +* `indices.get_data_lifecycle` - `master_timeout`. +* `indices.get_data_stream` - `master_timeout`. +* `indices.migrate_to_data_stream` - both. +* `indices.promote_data_stream` - `master_timeout`. +* `search_shards` - `master_timeout`. + +**APIs Promoted from Experimental to Stable:** + +* `indices.delete_data_lifecycle` +* `indices.explain_data_lifecycle` +* `indices.get_data_lifecycle` +* `indices.put_data_lifecycle` +* `security.create_cross_cluster_api_key` +* `security.update_cross_cluster_api_key` + +**New APIs** + +* `ingest.delete_ip_location_database` - Deletes an ip location database configuration. +* `ingest.get_ip_location_database` - Returns the specified ip location database configuration. +* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded. + + +**New Experimental APIs** + +* `inference.stream_inference` - Perform streaming inference. +* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria. diff --git a/docs/release_notes/817.asciidoc b/docs/release_notes/817.asciidoc new file mode 100644 index 0000000000..6537a6c546 --- /dev/null +++ b/docs/release_notes/817.asciidoc @@ -0,0 +1,81 @@ +[[release_notes_8_17]] +=== 8.17 Release notes + +[discrete] +[[release_notes_8_17_2]] +=== 8.17.2 Release notes + +[discrete] +==== API + +New APIs: + +* `esql.async_query_delete` +* `indices.get_data_lifecycle_stats` +* `inference.update` +* `security.delegate_pki` + +Updated APIs: + +* `async_search.submit` - Adds `keep_alive` Time parameter. +* `indices.put_template` - Adds `cause` String parameter. +* `xpack.info` - Adds `human` parameter for human-readable information. +* Timeout parameters updated: +** `:master_timeout` (Time), explicit operation timeout for connection to master node. +** `:timeout` (Time), explicit operation timeout. +*** Added to: +**** `index_lifecycle_management.delete_lifecycle` - adds both. +**** `index_lifecycle_management.delete_lifecycle` - adds `master_timeout`. +**** `index_lifecycle_management.get_lifecycle` - adds both. +**** `index_lifecycle_management.put_lifecycle` - adds both. +**** `index_lifecycle_management.start` - adds both. +**** `index_lifecycle_management.stop` - adds both. +**** `ingest.delete_geoip_database` - adds both. +**** `ingest.delete_geoip_location_database` - adds both. +**** `ingest.put_geoip_database` - adds both. +**** `ingest.put_ip_location_database` - adds both. +**** `license.post_start_trial` - removes `timeout`. +**** `shutdown.delete_node` - adds both. +**** `shutdown.put_node` - adds both. +**** `snapshot_lifecycle_management.delete_lifecycle` - adds both. +**** `snapshot_lifecycle_management.execute_lifecycle` - adds both. +**** `snapshot_lifecycle_management.execute_retention` - adds both. +**** `snapshot_lifecycle_management.get_lifecycle` - adds both. +**** `snapshot_lifecycle_management.get_stats` - adds both. +**** `snapshot_lifecycle_management.get_status` - adds both. +**** `snapshot_lifecycle_management.put_lifecycle` - adds both. + +APIs promoted from Experimental to Stable: + +* `inference.delete` +* `inference.get` +* `inference.inference` +* `inference.put` +* `inference.stream_inference` + +[discrete] +[[release_notes_8_17_1]] +=== 8.17.1 Release notes + +[discrete] +==== Client + +* Fixes ScrollHelper issue https://github.com/elastic/elasticsearch-ruby/issues/2556[#2556] - There was a bug where an additional search (with scroll) request was made to Elasticsearch for each resulting hit. It was rewritten so that the docs are retrieved as needed and the Helper instance doesn't store documents internally, with big savings in memory and requests to Elasticsearch. + +[discrete] +[[release_notes_8_17_0]] +=== 8.17.0 Release notes + +[discrete] +==== Client +* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. + +[discrete] +==== API + +[discrete] +===== API changes +* `async_search.submit` - Removes `keep_alive` parameter. Adds: +** `ccs_minimize_roundtrips` (Boolean): When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters. +** `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response. +* `open_point_in_time` - Adds `allow_partial_search_results` (Boolean) parameter: Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception (default: false). diff --git a/docs/release_notes/818.asciidoc b/docs/release_notes/818.asciidoc new file mode 100644 index 0000000000..c03bba4081 --- /dev/null +++ b/docs/release_notes/818.asciidoc @@ -0,0 +1,54 @@ +[[release_notes_8_18]] +=== 8.18 Release notes + +[discrete] +[[release_notes_8_18_0]] +=== 8.18.0 Release notes + +[discrete] +==== API + +New APIs: + +* `esql.async_query_stop` - Stops a previously submitted async query request given its ID and collects the results. +* `inference.chat_completion_unified` - Perform chat completion inference +* `inference.completion` - Perform completion inference +* `inference.put_alibabacloud` - Configure an AlibabaCloud AI Search inference endpoint +* `inference.put_amazonbedrock` - Configure an Amazon Bedrock inference endpoint +* `inference.put_anthropic` - Configure an Anthropic inference endpoint +* `inference.put_azureaistudio` - Configure an Azure AI Studio inference endpoint +* `inference.put_azureopenai` - Configure an Azure OpenAI inference endpoint +* `inference.put_cohere` - Configure a Cohere inference endpoint +* `inference.put_elasticsearch` - Configure an Elasticsearch inference endpoint +* `inference.put_elser` - Configure an ELSER inference endpoint +* `inference.put_googleaistudio` - Configure a Google AI Studio inference endpoint +* `inference.put_googlevertexai` - Configure a Google Vertex AI inference endpoint +* `inference.put_hugging_face` - Configure a HuggingFace inference endpoint +* `inference.put_jinaai` - Configure a JinaAI inference endpoint +* `inference.put_mistral` - Configure a Mistral inference endpoint +* `inference.put_openai` - Configure an OpenAI inference endpoint +* `inference.put_voyageai` - Configure a VoyageAI inference endpoint +* `inference.put_watsonx` - Configure a Watsonx inference endpoint +* `inference.rerank` - Perform reranking inference +* `inference.sparse_embedding` - Perform sparse embedding inference +* `inference.stream_inference` renamed to `inference.stream_completion` - Perform streaming completion inference. +* `inference.text_embedding` - Perform text embedding inference + + +Updated APIs: + +* `bulk`, `create`, `index`, `update` - Add Boolean parameter `:include_source_on_error`, if to include the document source in the error message in case of parsing errors (defaults to true). +* `cat.segments` +** Adds Boolean parameter `:local`, return local information, do not retrieve the state from master node (default: false). +** Adds Time parameter `:master_timeout`, explicit operation timeout for connection to master node. +* `cat.tasks` +** Adds Time parameter `:timeout`, period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. +** Adds Boolean parameter `:wait_for_completion`, if `true`, the request blocks until the task has completed. +* `eql.search` +** Adds Boolean parameter `:allow_partial_search_results`, control whether the query should keep running in case of shard failures, and return partial results. +** Adds Boolean parameter `:allow_partial_sequence_results`, control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true. +* `index_lifecycle_management.delete_lifecycle`, `index_lifecycle_management.explain_lifecycle`, `index_lifecycle_management.get_lifecycle`, `index_lifecycle_management.put_lifecycle`, `index_lifecycle_management.start`, `index_lifecycle_management.stop`, remove `:master_timeout`, `:timeout` parameters. +* `indices.resolve_cluster` - Adds `:timeout` parameter, `:name` no longer a required parameter. +* `indices.rollover` - Removes target_failure_store parameter. +* `ingest.delete_geoip_database`, `ingest.delete_ip_location_database`, `put_geoip_database`, `put_ip_location_database` remove `:master_timeout`, `:timeout` parameters. +* `machine_learning.start_trained_model_deployment` - Adds body request parameter, the settings for the trained model deployment. diff --git a/docs/release_notes/819.asciidoc b/docs/release_notes/819.asciidoc new file mode 100644 index 0000000000..67253468f0 --- /dev/null +++ b/docs/release_notes/819.asciidoc @@ -0,0 +1,68 @@ +[[release_notes_8_19]] +=== 8.19 Release notes + +[discrete] +[[release_notes_8_19_1]] +=== 8.19.1 Release notes + +[discrete] +==== API +* Updated source code documentation links to Elasticsearch documentation to 8.19 +* Adds `transform.set_upgrade_mode` - Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade. + +[discrete] +[[release_notes_8_19_0]] +=== 8.19.0 Release notes + +[discrete] +==== Client + +Tested versions of Ruby for 8.19.0: Ruby (MRI) 3.1, 3.2, 3.3, 3.4. JRuby 9.3, JRuby 9.4 and JRuby 10. + +[discrete] +==== API + +[discrete] +===== API changes + +* `cluster.get_component_template` - Adds `flat_settings` boolean parameter, return settings in flat format (default: false). Adds `settings_filter` String parameter, filter out results, for example to filter out sensitive information. +* `cluster.put_component_template` - Removes `timeout` parameter, adds `cause` String parameter, used defined reason for creation. +* `create` - Adds `require_alias` and `require_data_stream` boolean parameters, to specify required type to be created. +* `eql.search` - Adds `ccs_minimize_roundtrips`, `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `esql.async_query` - Adds `allow_partial_results` boolean parameter. +* `esql.async_query_get` - Adds `format` String parameter (e.g. json, yaml). +* `esql.query` - Adds `allow_partial_results` boolean parameter. +* `indices.recovery` - Adds `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `msearch` - Adds `ignore_unavailable`, `ignore_throttled`, `allow_no_indices`, `include_named_queries_score` boolean parameters, `expand_wildcards` String parameter and `routing`, a comma-separated list of specific routing values. +* `open_point_in_time` - Adds `max_concurrent_shard_requests` parameter, the number of concurrent shard requests per node executed concurrently when opening this point-in-time +* `reindex` - Adds `require_alias` boolean parameter. +* `search_mvt` - Adds `grid_agg` String parameter, aggregation used to create a grid for `field`. +* `snapshot.repository_analyze` - Adds `register_operation_count` parameter, the minimum number of linearizable register operations to perform in total. + +Time parameters `master_timeout` and `timeout` have been added to the following APIs: + +* `index_lifecycle_management`: +** `delete_lifecycle` +** `get_lifecycle` +** `put_lifecycle` +** `start` +** `stop` +** `explain_lifecycle` - Only `master_timeout` + +* `ingest`: +** `delete_geoip_database` +** `delete_ip_location_database` +** `put_geoip_database` +** `put_ip_location_database` + +[discrete] +===== New APIs + +* `indices.delete_data_stream_options` - Deletes the data stream options of the selected data streams. +* `indices.get_data_stream_options` - Returns the data stream options of the selected data streams. +* `indices.get_data_stream_settings` - Gets a data stream's settings. +* `indices.put_data_stream_options` - Updates the data stream options of the selected data streams. +* `indices.put_data_stream_settings` - Updates a data stream's settings. +* `inference.put_amazonsagemaker` - Configure an Amazon SageMaker inference endpoint. +* `inference.put_custom` - Configure a custom inference endpoint. +* `inference.put_deepseek` - Configure a DeepSeek inference endpoint. diff --git a/docs/release_notes/index.asciidoc b/docs/release_notes/index.asciidoc index 2c6223c830..ac85d25d82 100644 --- a/docs/release_notes/index.asciidoc +++ b/docs/release_notes/index.asciidoc @@ -3,6 +3,10 @@ [discrete] === 8.x +* <> +* <> +* <> +* <> * <> * <> * <> @@ -37,6 +41,10 @@ * <> * <> +include::819.asciidoc[] +include::818.asciidoc[] +include::817.asciidoc[] +include::816.asciidoc[] include::815.asciidoc[] include::814.asciidoc[] include::813.asciidoc[] diff --git a/elasticsearch-api/Gemfile b/elasticsearch-api/Gemfile index d65c401d73..6f2646fa20 100644 --- a/elasticsearch-api/Gemfile +++ b/elasticsearch-api/Gemfile @@ -20,8 +20,8 @@ source 'https://rubygems.org/' # Specify your gem's dependencies in elasticsearch-api.gemspec gemspec -if File.exist? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __dir__) - gem 'elasticsearch', path: File.expand_path('../../elasticsearch', __dir__), require: false +if File.exist? File.expand_path('../elasticsearch/elasticsearch.gemspec', __dir__) + gem 'elasticsearch', path: File.expand_path('../elasticsearch', __dir__), require: false end group :development do diff --git a/elasticsearch-api/Rakefile b/elasticsearch-api/Rakefile index 58c9dede1e..fe3b2f0faf 100644 --- a/elasticsearch-api/Rakefile +++ b/elasticsearch-api/Rakefile @@ -36,6 +36,7 @@ namespace :test do RSpec::Core::RakeTask.new(:spec) do |t| t.pattern = 'spec/elasticsearch/api/**/*_spec.rb' t.exclude_pattern = 'spec/platinum/**/*_spec.rb' + t.exclude_pattern += ',spec/elasticsearch/api/perform_request_spec.rb' unless ENV['TEST_WITH_OTEL'] end desc 'Run Rest API Spec tests' diff --git a/elasticsearch-api/api-spec-testing/rspec_matchers.rb b/elasticsearch-api/api-spec-testing/rspec_matchers.rb index 410102af0e..cb8db34b5d 100644 --- a/elasticsearch-api/api-spec-testing/rspec_matchers.rb +++ b/elasticsearch-api/api-spec-testing/rspec_matchers.rb @@ -174,7 +174,7 @@ failure_message do |response| "the expected response pair/value(s) #{@mismatched_pairs}" + - " does not match the pair/value(s) in the response #{response}" + " does not match the pair/value(s) in the response #{response}" end def sanitize_pairs(expected_pairs) @@ -235,8 +235,14 @@ def compare_hash(expected_pairs, actual_hash, test) when Hash compare_hash(expected_value, actual_value, test) when Array - unless compare_array(expected_value, actual_value, test, actual_hash) - @mismatched_pairs.merge!(expected_key => expected_value) + begin + unless compare_array(expected_value.sort, actual_value.sort, test, actual_hash) + @mismatched_pairs.merge!(expected_key => expected_value) + end + rescue TypeError, ArgumentError + unless compare_array(expected_value, actual_value, test, actual_hash) + @mismatched_pairs.merge!(expected_key => expected_value) + end end when String unless compare_string(expected_value, actual_value, test, actual_hash) @@ -283,6 +289,8 @@ def compare_array(expected, actual, test, response) return false unless compare_array(value, actual[i], test, response) when String return false unless compare_string(value, actual[i], test, response) + else + true end end end diff --git a/elasticsearch-api/api-spec-testing/wipe_cluster.rb b/elasticsearch-api/api-spec-testing/wipe_cluster.rb index 083a20dd6e..1da765be12 100644 --- a/elasticsearch-api/api-spec-testing/wipe_cluster.rb +++ b/elasticsearch-api/api-spec-testing/wipe_cluster.rb @@ -23,14 +23,60 @@ module Elasticsearch module RestAPIYAMLTests module WipeCluster PRESERVE_ILM_POLICY_IDS = [ - 'ilm-history-ilm-policy', 'slm-history-ilm-policy', 'watch-history-ilm-policy', - 'watch-history-ilm-policy-16', 'ml-size-based-ilm-policy', 'logs', 'metrics', 'profiling', - 'synthetics', '7-days-default', '30-days-default', '90-days-default', '180-days-default', - '365-days-default', '.fleet-files-ilm-policy', '.fleet-file-data-ilm-policy', - '.fleet-actions-results-ilm-policy', '.fleet-file-fromhost-data-ilm-policy', - '.fleet-file-fromhost-meta-ilm-policy', '.fleet-file-tohost-data-ilm-policy', - '.fleet-file-tohost-meta-ilm-policy', '.deprecation-indexing-ilm-policy', - '.monitoring-8-ilm-policy', 'behavioral_analytics-events-default_policy' + 'ilm-history-ilm-policy', + 'slm-history-ilm-policy', + 'watch-history-ilm-policy', + 'watch-history-ilm-policy-16', + 'ml-size-based-ilm-policy', + 'logs', + 'logs@lifecycle', + 'metrics', + 'metrics@lifecycle', + 'profiling-60-days', + 'profiling-60-days@lifecycle', + 'synthetics', + 'agentless', + 'synthetics@lifecycle', + 'traces@lifecycle', + '7-days-default', + '7-days@lifecycle', + '30-days-default', + '30-days@lifecycle', + '90-days-default', + '90-days@lifecycle', + '180-days-default', + '180-days@lifecycle', + '365-days-default', + '365-days@lifecycle', + '.fleet-files-ilm-policy', + '.fleet-file-data-ilm-policy', + '.fleet-actions-results-ilm-policy', + '.fleet-file-fromhost-data-ilm-policy', + '.fleet-file-fromhost-meta-ilm-policy', + '.fleet-file-tohost-data-ilm-policy', + '.fleet-file-tohost-meta-ilm-policy', + '.deprecation-indexing-ilm-policy', + '.monitoring-8-ilm-policy', + 'behavioral_analytics-events-default_policy', + 'logs-apm.app_logs-default_policy', + 'logs-apm.error_logs-default_policy', + 'metrics-apm.app_metrics-default_policy', + 'metrics-apm.internal_metrics-default_policy', + 'metrics-apm.service_destination_10m_metrics-default_policy', + 'metrics-apm.service_destination_1m_metrics-default_policy', + 'metrics-apm.service_destination_60m_metrics-default_policy', + 'metrics-apm.service_summary_10m_metrics-default_policy', + 'metrics-apm.service_summary_1m_metrics-default_policy', + 'metrics-apm.service_summary_60m_metrics-default_policy', + 'metrics-apm.service_transaction_10m_metrics-default_policy', + 'metrics-apm.service_transaction_1m_metrics-default_policy', + 'metrics-apm.service_transaction_60m_metrics-default_policy', + 'metrics-apm.transaction_10m_metrics-default_policy', + 'metrics-apm.transaction_1m_metrics-default_policy', + 'metrics-apm.transaction_60m_metrics-default_policy', + 'traces-apm.rum_traces-default_policy', + 'traces-apm.sampled_traces-default_policy', + 'traces-apm.traces-default_policy' ].freeze PLATINUM_TEMPLATES = [ @@ -395,24 +441,27 @@ def clear_privileges(client) def clear_ml_jobs(client) client.ml.close_job(job_id: '_all', force: true) client.ml.get_jobs['jobs'].each do |d| - client.ml.delete_job(job_id: d['job_id']) + client.ml.delete_job(job_id: d['job_id'], wait_for_completion: false, force: true) end end def clear_datafeeds(client) client.ml.stop_datafeed(datafeed_id: '_all', force: true) client.ml.get_datafeeds['datafeeds'].each do |d| - client.ml.delete_datafeed(datafeed_id: d['datafeed_id']) + Thread.new do + client.ml.stop_datafeed(datafeed_id: d['datafeed_id'], force: true) + client.ml.delete_datafeed(datafeed_id: d['datafeed_id'], force: true) + rescue StandardError + logger.info('Exception deleting datafeed') + end end end def clear_tasks(client) tasks = client.tasks.get['nodes'].values.first['tasks'].values.select do |d| d['cancellable'] - end.map do |d| - "#{d['node']}:#{d['id']}" end - tasks.each { |t| client.tasks.cancel task_id: t } + tasks.each { |d| client.tasks.cancel(task_id: "#{d['node']}:#{d['id']}") } end def clear_machine_learning_indices(client) @@ -429,7 +478,7 @@ def clear_index_templates(client) def clear_transforms(client) client.transform.get_transform(transform_id: '*')['transforms'].each do |transform| - client.transform.delete_transform(transform_id: transform['id']) + client.transform.delete_transform(transform_id: transform['id'], force: true) end end diff --git a/elasticsearch-api/elasticsearch-api.gemspec b/elasticsearch-api/elasticsearch-api.gemspec index a458ed60d1..ebc59fcf0d 100644 --- a/elasticsearch-api/elasticsearch-api.gemspec +++ b/elasticsearch-api/elasticsearch-api.gemspec @@ -49,7 +49,7 @@ Gem::Specification.new do |s| s.add_development_dependency 'ansi' s.add_development_dependency 'bundler' s.add_development_dependency 'elasticsearch' - s.add_development_dependency 'elasticsearch-test-runner' unless defined?(JRUBY_VERSION) && JRUBY_VERSION <= "9.4" + s.add_development_dependency 'elasticsearch-test-runner' unless defined?(JRUBY_VERSION) && JRUBY_VERSION <= '9.4' s.add_development_dependency 'minitest' s.add_development_dependency 'minitest-reporters', '>= 1.6' s.add_development_dependency 'mocha' @@ -59,6 +59,7 @@ Gem::Specification.new do |s| s.add_development_dependency 'yard' # Gems for testing integrations + s.add_development_dependency 'concurrent-ruby', '1.3.4' if defined? JRUBY_VERSION && JRUBY_VERSION < '9.4' s.add_development_dependency 'jsonify' s.add_development_dependency 'hashie' # Temporary support for Ruby 2.6, since it's EOL March 2022: 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 21fefe4527..fc56ea296e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module AsyncSearch module Actions - # Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. + # Delete an async search # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.delete' } 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 92c26c5887..b30ae0c7bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module AsyncSearch module Actions - # Retrieves the results of a previously submitted async search request given its ID. + # Get async search results # # @option arguments [String] :id The async search ID # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.get' } 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 4b2008d03d..2e0ca100f8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module AsyncSearch module Actions - # Retrieves the status of a previously submitted async search request given its ID. + # Get the async search status # # @option arguments [String] :id The async search ID # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html # def status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.status' } 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 c782d56b3e..42f1808805 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module AsyncSearch module Actions - # Executes a search request asynchronously. + # Run an async search # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response @@ -32,6 +32,7 @@ module Actions # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true # @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) + # @option arguments [Boolean] :ccs_minimize_roundtrips When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters. # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) # @option arguments [String] :df The field to use as default where no field prefix is given in the query string # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit @@ -44,6 +45,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) + # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response # @option arguments [String] :q Query in the Lucene query string syntax # @option arguments [List] :routing A comma-separated list of specific routing values # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) @@ -69,7 +71,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition using the Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html # def submit(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.submit' } 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 6672db4b28..8b8e1e61bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Autoscaling module Actions - # Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Delete an autoscaling policy # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-delete-autoscaling-policy.html # def delete_autoscaling_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.delete_autoscaling_policy' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb index 9fba921f3a..f0969e05de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Autoscaling module Actions - # Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Get the autoscaling capacity # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html # def get_autoscaling_capacity(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.get_autoscaling_capacity' } 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 9090bdbc74..b7170a67f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Autoscaling module Actions - # Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Get an autoscaling policy # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html # def get_autoscaling_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.get_autoscaling_policy' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb index b453f52c9f..813766569f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Autoscaling module Actions - # Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Create or update an autoscaling policy # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Time] :master_timeout Timeout for processing on master node @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body the specification of the autoscaling policy (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-put-autoscaling-policy.html # def put_autoscaling_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.put_autoscaling_policy' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb index a78a1d3463..c86409f84e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb @@ -21,14 +21,13 @@ module Elasticsearch module API module Actions - # Allows to perform multiple index/update/delete operations in a single request. + # Bulk index or delete documents # # @option arguments [String] :index Default index for items which don't provide one # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [String] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [String] :type Default document type for items which don't provide one # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request @@ -36,11 +35,12 @@ module Actions # @option arguments [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false) # @option arguments [Boolean] :require_data_stream When true, requires the destination to be a data stream (existing or to-be-created). Default is false # @option arguments [Boolean] :list_executed_pipelines Sets list_executed_pipelines for all incoming documents. Defaults to unset (false) + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs, # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-bulk.html # def bulk(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'bulk' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/capabilities.rb b/elasticsearch-api/lib/elasticsearch/api/actions/capabilities.rb index f769dce688..839216f490 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/capabilities.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/capabilities.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :local_only True if only the node being called should be considered # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://github.com/elastic/elasticsearch/blob/current/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities + # @see https://github.com/elastic/elasticsearch/blob/8.19/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities # def capabilities(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'capabilities' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 0b506b2ed0..0e1443d9dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Shows information about currently configured aliases to indices including filter and routing infos. + # Get aliases # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -32,9 +32,11 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-alias.html # def aliases(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.aliases' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index f37b53e12d..5c4397a441 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -22,11 +22,12 @@ module Elasticsearch module API module Cat module Actions - # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + # Get shard allocation information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [List] :h Comma-separated list of column names to display @@ -35,7 +36,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-allocation.html # def allocation(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.allocation' } 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 0765a09a55..3a4962323c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about existing component_templates templates. + # Get component templates # # @option arguments [String] :name A pattern that returned component template names must match # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -32,9 +32,11 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-component-templates.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-component-templates.html # def component_templates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.component_templates' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index 8afd4cade6..fa6a1a394d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Provides quick access to the document count of the entire cluster, or individual indices. + # Get a document count # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -30,9 +30,11 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-count.html # def count(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.count' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index 592958c962..1d98f94e86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -22,18 +22,19 @@ module Elasticsearch module API module Cat module Actions - # Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + # Get field data cache information # # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-fielddata.html # def fielddata(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.fielddata' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index 59309d5084..a4e2fc05f8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns a concise representation of the cluster health. + # Get the cluster health status # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display @@ -31,9 +31,10 @@ module Actions # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :ts Set to false to disable timestamping # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-health.html # def health(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.health' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb index 0d9f22f752..781e73119a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb @@ -22,13 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Returns help for the Cat APIs. + # Get CAT help # - # @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 # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat.html # def help(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.help' } @@ -40,7 +38,7 @@ def help(arguments = {}) method = Elasticsearch::API::HTTP_GET path = '_cat' - params = Utils.process_params(arguments) + params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index accc79e8cb..6826a215f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Returns information about indices: number of primaries and replicas, document counts, disk size, ... + # Get index information # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red) @@ -39,7 +39,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-indices.html # def indices(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.indices' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index f8512afd3b..e5242cbe11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about the master node. + # Get master node information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -31,9 +31,11 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-master.html # def master(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.master' } 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 72e1f69773..eefa12efa1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about data frame analytics jobs. + # Get data frame analytics jobs # # @option arguments [String] :id The ID of the data frame analytics to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-dfanalytics.html # def ml_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb index c00d25ba2c..7db400a71e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about datafeeds. + # Get datafeeds # # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) @@ -32,9 +32,10 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-datafeeds.html # def ml_datafeeds(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_datafeeds' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb index 0a9f41ff97..00723cf7e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about anomaly detection jobs. + # Get anomaly detection jobs # # @option arguments [String] :job_id The ID of the jobs stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-anomaly-detectors.html # def ml_jobs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_jobs' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb index 3af9c15a30..6ba80368dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about inference trained models. + # Get trained models # # @option arguments [String] :model_id The ID of the trained models stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) # @option arguments [Integer] :from skips a number of trained models # @option arguments [Integer] :size specifies a max number of trained models to get - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information @@ -37,7 +37,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-trained-model.html # def ml_trained_models(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_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 54102162ef..6fc865f366 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about custom node attributes. + # Get node attribute information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -31,9 +31,11 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodeattrs.html # def nodeattrs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.nodeattrs' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index 1411277c44..61c506715c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -22,9 +22,9 @@ module Elasticsearch module API module Cat module Actions - # Returns basic statistics about performance of cluster nodes. + # Get node information # - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -36,7 +36,7 @@ module Actions # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodes.html # def nodes(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.nodes' } 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 67acfd7817..4d8ee9fac4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns a concise representation of the cluster pending tasks. + # Get pending task information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -32,9 +32,10 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-pending-tasks.html # def pending_tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.pending_tasks' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index fbde5d60ed..3935cbc332 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about installed plugins across nodes node. + # Get plugin information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -32,9 +32,11 @@ module Actions # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-plugins.html # def plugins(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.plugins' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index 5e6865e47d..6f7d6afe8e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Cat module Actions - # Returns information about index shard recoveries, both on-going completed. + # Get shard recovery information # # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information @@ -36,7 +36,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-recovery.html # def recovery(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.recovery' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb index 482ceff4b3..0dc4ea89a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about snapshot repositories registered in the cluster. + # Get snapshot repository information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node @@ -31,9 +31,11 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-repositories.html # def repositories(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.repositories' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 8898f52e26..a61c07506f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -22,18 +22,21 @@ module Elasticsearch module API module Cat module Actions - # Provides low-level information about the segments in the shards of an index. + # Get segment information # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-segments.html # def segments(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.segments' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index 4e4cae17d5..9c1012b156 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Provides a detailed view of shard allocation on nodes. + # Get shard information # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-shards.html # def shards(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.shards' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 3ae1c00888..649418bf21 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns all snapshots in a specific repository. + # Get snapshot information # # @option arguments [List] :repository Name of repository from which to fetch the snapshot information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -33,9 +33,10 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-snapshots.html # def snapshots(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.snapshots' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index 4a60aea199..4b563fbb36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about the tasks currently executing on one or more nodes in the cluster. + # Get task information # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -38,9 +38,12 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed. + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-tasks.html # def tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.tasks' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index 42423d5f2b..af0e842b88 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about existing templates. + # Get index template information # # @option arguments [String] :name A pattern that returned template names must match # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -32,9 +32,11 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-templates.html # def templates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.templates' } 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 f3ffd705f2..5089909fe3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -22,8 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns cluster-wide thread pool statistics per node. - # By default the active, queue and rejected statistics are returned for all thread pools. + # Get thread pool statistics # # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -34,9 +33,10 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-thread-pool.html # def thread_pool(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.thread_pool' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index 172e7445ae..dd1c80fa9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about transforms. + # Get transform information # # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 @@ -34,9 +34,10 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-transforms.html # def transforms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.transforms' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb index 793bff1eab..a8873b31de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Explicitly clears the search context for a scroll. + # Clear a scrolling search # # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers @@ -32,7 +32,7 @@ module Actions # Deprecated since version 7.0.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-scroll-api.html # def clear_scroll(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'clear_scroll' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb index 05b7b5935a..6eec2d05ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb @@ -26,7 +26,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body a point-in-time id to close # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html # def close_point_in_time(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'close_point_in_time' } 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 08abe8949a..cd7da4e3ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Provides explanations for shard allocations in the cluster. + # Explain the shard allocations # # @option arguments [Time] :master_timeout Timeout for connection to master node # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false) @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard' # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-allocation-explain.html # def allocation_explain(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.allocation_explain' } 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 a0a62dd669..81820a3050 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Cluster module Actions - # Deletes a component template + # Delete component templates # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html # def delete_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.delete_component_template' } 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 4609b743de..81205de3f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Cluster module Actions - # Clears cluster voting config exclusions. + # Clear cluster voting config exclusions # # @option arguments [Boolean] :wait_for_removal Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. # @option arguments [Time] :master_timeout Timeout for submitting request to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions # def delete_voting_config_exclusions(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.delete_voting_config_exclusions' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb index b0ac619b26..5c3da0681a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Cluster module Actions - # Returns information about whether a particular component template exist + # Check component templates # # @option arguments [String] :name The name of the template # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html # def exists_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.exists_component_template' } 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 51bb22bc01..32c25e5e95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb @@ -22,15 +22,17 @@ module Elasticsearch module API module Cluster module Actions - # Returns one or more component templates + # Get component templates # # @option arguments [List] :name The comma separated names of the component templates # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false) + # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) + # @option arguments [String] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html # def get_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.get_component_template' } 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 8cff9de9d4..72be4bd8be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns cluster settings. + # Get cluster-wide settings # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-get-settings.html # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.get_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index 3a585036b6..1cc104481c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns basic information about the health of the cluster. + # Get the cluster health status # # @option arguments [List] :index Limit the information returned to a specific index # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) @@ -38,7 +38,7 @@ module Actions # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-health.html # def health(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.health' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb index 83b2e81d83..bad4902b65 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Cluster module Actions - # Returns different information about the cluster. + # Get cluster info # # @option arguments [List] :target Limit the information returned to the specified target. (options: _all, http, ingest, thread_pool, script) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-info.html # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.info' } 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 783626ef7d..6caa3752b7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb @@ -22,14 +22,13 @@ module Elasticsearch module API module Cluster module Actions - # Returns a list of any cluster-level changes (e.g. create index, update mapping, - # allocate or fail shard) which have not yet been executed. + # Get the pending cluster tasks # # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-pending.html # def pending_tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.pending_tasks' } 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 dd9edf0cbe..25724690bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Updates the cluster voting config exclusions by node ids or node names. + # Update voting configuration exclusions # # @option arguments [String] :node_ids A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names. # @option arguments [String] :node_names A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids. @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Timeout for submitting request to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions # def post_voting_config_exclusions(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.post_voting_config_exclusions' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb index e6cf352034..105b2c6c72 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module Cluster module Actions - # Creates or updates a component template + # Create or update a component template # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :cause User defined reason for create the component template # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The template definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html # def put_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.put_component_template' } 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 22854aaf9b..695190ac9d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Updates the cluster settings. + # Update the cluster settings # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-update-settings.html # def put_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.put_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb index 63d1f824f7..0f398eaf82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cluster module Actions - # Returns the information about configured remote clusters. + # Get remote cluster information # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-remote-info.html # def remote_info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.remote_info' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb index 450384932f..38ef242d6e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Allows to manually change the allocation of individual shards in the cluster. + # Reroute the cluster # # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed @@ -33,7 +33,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-reroute.html # def reroute(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.reroute' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index 24d7eb487f..0c758e7ee6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns a comprehensive information about the state of the cluster. + # Get the cluster state # # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-state.html # def state(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.state' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb index 917ea93bb1..9acc6b48cf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Cluster module Actions - # Returns high-level overview of cluster statistics. + # Get cluster statistics # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) + # @option arguments [Boolean] :include_remotes Include remote cluster data into the response (default: false) # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-stats.html # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb index e2c46f6ffd..af1488011e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the last_seen timestamp in the connector document. + # Check in a connector # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/check-in-connector-api.html # def check_in(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.check_in' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb index 4e73882b30..6ff8df8de6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Deletes a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Delete a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be deleted. # @option arguments [Boolean] :delete_sync_jobs Determines whether associated sync jobs are also deleted. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-connector-api.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb index d71a01db6c..17dbe28f0f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module Connector module Actions - # Returns the details about a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be returned. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-connector-api.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb index 115f7745ab..d7942d4a73 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Lists all connectors. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get all connectors + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size Specifies a max number of results to get (default: 100) @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :query A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-connector-api.html # def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.list' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb index 6e2c055541..34858a05ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module Connector module Actions - # Creates a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The connector configuration. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-connector-api.html # def post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.post' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb index 038f37ab3c..e5e75755aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Creates or updates a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create or update a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be created or updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The connector configuration. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-connector-api.html # def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.put' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb index 931bec6795..e9bba65f06 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Deletes a connector secret. + # Deletes a connector secret # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb index 7ec6d602de..b9ea37d6f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Retrieves a secret stored by Connectors. + # Retrieves a secret stored by Connectors # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb index 311404cadd..f2952986c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Creates a secret for a Connector. + # Creates a secret for a Connector # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb index 94077f9da0..ced86732d6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Creates or updates a secret for a Connector. + # Creates or updates a secret for a Connector # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb index 3a6bcebf48..7abfb9c4c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module Connector module Actions - # Cancels a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Cancel a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be canceled # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cancel-connector-sync-job-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cancel-connector-sync-job-api.html # def sync_job_cancel(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_cancel' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb index 90e935c527..537f964bd3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Checks in a connector sync job (refreshes 'last_seen'). + # Check in a connector sync job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be checked in # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-sync-job-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/check-in-connector-sync-job-api.html # def sync_job_check_in(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_check_in' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb index f524141fc3..062ec41089 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Claims a connector sync job. + # Claim a connector sync job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Data to claim a sync job. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/claim-connector-sync-job-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/claim-connector-sync-job-api.html # def sync_job_claim(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_claim' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb index 3a7ed141ca..ebb5fbe440 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module Connector module Actions - # Deletes a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Delete a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be deleted. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-sync-job-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-connector-sync-job-api.html # def sync_job_delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb index 73ed91cbd3..6a4ffc2434 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Sets an error for a connector sync job. + # Set a connector sync job error # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The error to set in the connector sync job. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/set-connector-sync-job-error-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/set-connector-sync-job-error-api.html # def sync_job_error(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_error' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb index 22e7554776..b4b902bcc1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module Connector module Actions - # Returns the details about a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be returned. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-sync-job-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-connector-sync-job-api.html # def sync_job_get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb index 222314a516..bb6ff2f68f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Lists all connector sync jobs. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get all connector sync jobs + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size specifies a max number of results to get (default: 100) @@ -35,7 +35,7 @@ module Actions # @option arguments [List] :job_type A comma-separated list of job types # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-sync-jobs-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-connector-sync-jobs-api.html # def sync_job_list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_list' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb index a455a80281..c06e31a00a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module Connector module Actions - # Creates a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The connector sync job data. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-sync-job-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-connector-sync-job-api.html # def sync_job_post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_post' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb index 772a28cf31..dd18f7b1a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the stats fields in the connector sync job document. + # Set the connector sync job stats # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The stats to update for the connector sync job. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/set-connector-sync-job-stats-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/set-connector-sync-job-stats-api.html # def sync_job_update_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_update_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb index 975c7aa3d7..0500d4441d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Activates the draft filtering rules if they are in a validated state. + # Activate the connector draft filter # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-api.html # def update_active_filtering(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_active_filtering' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb index a44130824e..7dbb330188 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the API key id and/or API key secret id fields in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector API key ID + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's API key id and/or Connector Secret document id for that API key. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-api-key-id-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-api-key-id-api.html # def update_api_key_id(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_api_key_id' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb index fc51bd4315..c84763aa67 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the connector configuration. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector configuration + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Mapping between field names to configuration. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-configuration-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-configuration-api.html # def update_configuration(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_configuration' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb index eec511fc21..734d7df95c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the error field in the connector document. + # Update the connector error field # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's error. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-error-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-error-api.html # def update_error(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_error' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb index 531a7c2ad1..e1462543d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the connector features in the connector document. + # Update the connector features # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's features definition. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-features-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-features-api.html # def update_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_features' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb index 314a30e6d7..cf35272c3f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the filtering field in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector filtering + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body A list of connector filtering configurations. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-api.html # def update_filtering(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_filtering' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb index b42a75b4db..5bf670da01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the validation info of the draft filtering rules. + # Update the connector draft filtering validation # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Validation info for the draft filtering rules (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-validation-api.html # def update_filtering_validation(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_filtering_validation' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb index ce76d01503..265a706f75 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the index name of the connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector index name + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's index name. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-index-name-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-index-name-api.html # def update_index_name(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_index_name' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb index ecdac5b2a7..2d0ca07176 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the name and/or description fields in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector name and description + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's name and/or description. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-name-description-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-name-description-api.html # def update_name(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_name' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb index 81779e6e38..ba9a8276bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the is_native flag of the connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector is_native flag + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's is_native flag (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/connector-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-native-api.html # def update_native(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_native' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb index e5f7f6ee23..9ef634b7f2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the pipeline field in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector pipeline + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object with connector ingest pipeline configuration. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-pipeline-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-pipeline-api.html # def update_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_pipeline' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb index 2c87061c26..4fd925e028 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the scheduling field in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector scheduling + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's scheduling configuration. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-scheduling-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-scheduling-api.html # def update_scheduling(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_scheduling' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb index 757b43c8ec..e7c4df83ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the service type of the connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector service type + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's service type. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-service-type-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-service-type-api.html # def update_service_type(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_service_type' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb index 8b1ef81f37..353dab2d4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the status of the connector. + # Update the connector status # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's status. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-status-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-status-api.html # def update_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb index 393bbb7fda..aac3bd520c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns number of documents matching a query. + # Count search results # # @option arguments [List] :index A comma-separated list of indices to restrict the results # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -41,7 +41,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-count.html # def count(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'count' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index b17cc55635..de4c0e5d56 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -21,9 +21,7 @@ module Elasticsearch module API module Actions - # Creates a new document in the index. - # - # Returns a 409 response when a document with a same ID already exists in the index. + # Create a new document in the index # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index @@ -34,10 +32,13 @@ module Actions # @option arguments [Number] :version Explicit version number for concurrency control # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + # @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false + # @option arguments [Boolean] :require_data_stream When true, requires destination to be a data stream (existing or to be created). Default is false # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The document (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html # def create(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'create' } 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 b3537c7ad1..e9909deb86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Deletes auto-follow patterns. + # Delete auto-follow patterns # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-delete-auto-follow-pattern.html # def delete_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.delete_auto_follow_pattern' } 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 c1fffadc12..ea6fe4cff4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Creates a new follower index configured to follow the referenced leader index. + # Create a follower # # @option arguments [String] :index The name of the follower index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The name of the leader index and other optional ccr related parameters (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-put-follow.html # def follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow' } 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 7ba6a422b0..5b7842f2dd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Retrieves information about all follower indices, including parameters and status for each follower index + # Get follower information # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-info.html # def follow_info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_info' } 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 85e45f1259..0b360a0eb7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + # Get follower stats # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-stats.html # def follow_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_stats' } 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 aa3726b0b6..551ea68760 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Removes the follower retention leases from the leader. + # Forget a follower # # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed # @option arguments [Time] :timeout Explicit operation timeout # @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*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-forget-follower.html # def forget_follower(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.forget_follower' } 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 ea4f844ef9..5ddb4051fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + # Get auto-follow patterns # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-auto-follow-pattern.html # def get_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.get_auto_follow_pattern' } 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 573bd73ad4..38c29fe94c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Pauses an auto-follow pattern + # Pause an auto-follow pattern # # @option arguments [String] :name The name of the auto follow pattern that should pause discovering new indices to follow. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-pause-auto-follow-pattern.html # def pause_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_auto_follow_pattern' } 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 275bd1675e..ac956f80c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + # Pause a follower # # @option arguments [String] :index The name of the follower index that should pause following its leader index. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-pause-follow.html # def pause_follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_follow' } 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 4ea1a7a754..03c94dcac1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + # Create or update auto-follow patterns # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The specification of the auto follow pattern (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-put-auto-follow-pattern.html # def put_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.put_auto_follow_pattern' } 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 2a979f9add..9b0dcb5979 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Resumes an auto-follow pattern that has been paused + # Resume an auto-follow pattern # # @option arguments [String] :name The name of the auto follow pattern to resume discovering new indices to follow. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-resume-auto-follow-pattern.html # def resume_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_auto_follow_pattern' } 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 f172d59a88..439c0b5463 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Resumes a follower index that has been paused + # Resume a follower # # @option arguments [String] :index The name of the follow index to resume following. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The name of the leader index and other optional ccr related parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-resume-follow.html # def resume_follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_follow' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb index 276ce44b34..0eec88abd0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Gets all stats related to cross-cluster replication. + # Get cross-cluster replication stats # # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-stats.html # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.stats' } 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 9719fd23a4..acc106998c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + # Unfollow an index # # @option arguments [String] :index The name of the follower index that should be turned into a regular index. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-unfollow.html # def unfollow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.unfollow' } 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 82810e3a02..ba14bfa49d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module DanglingIndices module Actions - # Deletes the specified dangling index + # Delete a dangling index # # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to delete the dangling index @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-index-delete.html # def delete_dangling_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.delete_dangling_index' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb index 3806639cb2..1e3ac7f476 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module DanglingIndices module Actions - # Imports the specified dangling index + # Import a dangling index # # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to import the dangling index @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-index-import.html # def import_dangling_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.import_dangling_index' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb index a46ca9851c..39b64bc75d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module DanglingIndices module Actions - # Returns all dangling indices. + # Get the dangling indices # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-indices-list.html # def list_dangling_indices(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.list_dangling_indices' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb index 3d0505817f..e62199346d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Removes a document from the index. + # Delete a document # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index @@ -35,7 +35,7 @@ module Actions # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete' } 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 395cd50618..44abcb9c69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Deletes documents matching the provided query. + # Delete documents # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :analyzer The analyzer to use for the query string @@ -56,7 +56,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition using the Query DSL (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html # def delete_by_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query' } 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 081b6efc86..66434f2855 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Delete By Query operation. + # Throttle a delete by query operation # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html#docs-delete-by-query-rethrottle # def delete_by_query_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query_rethrottle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb index 9f1d8be915..34d49b27b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb @@ -21,14 +21,14 @@ module Elasticsearch module API module Actions - # Deletes a script. + # Delete a script or search template # # @option arguments [String] :id Script ID # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-stored-script-api.html # def delete_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_script' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb index de116ae993..c645d9cee0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Enrich module Actions - # Deletes an existing enrich policy and its enrich index. + # Delete an enrich policy # # @option arguments [String] :name The name of the enrich policy # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-enrich-policy-api.html # def delete_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.delete_policy' } 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 f30444fefe..85a8464bd5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Enrich module Actions - # Creates the enrich index for an existing enrich policy. + # Run an enrich policy # # @option arguments [String] :name The name of the enrich policy # @option arguments [Boolean] :wait_for_completion Should the request should block until the execution is complete. # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/execute-enrich-policy-api.html # def execute_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.execute_policy' } 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 802e5d1027..d9d6ea8c23 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Enrich module Actions - # Gets information about an enrich policy. + # Get an enrich policy # # @option arguments [List] :name A comma-separated list of enrich policy names # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-enrich-policy-api.html # def get_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.get_policy' } 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 b93de33b2c..7aa0b1dba1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Enrich module Actions - # Creates a new enrich policy. + # Create an enrich policy # # @option arguments [String] :name The name of the enrich policy # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The enrich policy to register (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-enrich-policy-api.html # def put_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.put_policy' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb index 8a71c336d4..cffc5d36b8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Enrich module Actions - # Gets enrich coordinator statistics and information about enrich policies that are currently executing. + # Get enrich stats # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/enrich-stats-api.html # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb index d0a794a594..3a6974528c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Eql module Actions - # Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. + # Delete an async EQL search # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-eql-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb index 87341090a1..cc5b59f667 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Eql module Actions - # Returns async results from previously executed Event Query Language (EQL) search + # Get async EQL search results # # @option arguments [String] :id The async search ID # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-async-eql-search-api.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb index 06e4d98460..47a796e3f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Eql module Actions - # Returns the status of a previously submitted async or stored Event Query Language (EQL) search + # Get the async EQL status # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-async-eql-status-api.html # def get_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.get_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 097aa24509..39c520ced9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -22,16 +22,22 @@ module Elasticsearch module API module Eql module Actions - # Returns results matching a query expressed in Event Query Language (EQL) + # Get EQL search results # # @option arguments [String] :index The name of the index to scope the operation # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @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) # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available + # @option arguments [Boolean] :allow_partial_search_results Control whether the query should keep running in case of shard failures, and return partial results + # @option arguments [Boolean] :allow_partial_sequence_results Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true. + # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) + # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Eql request body. Use the `query` to limit the query scope. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/eql-search-api.html # def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.search' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb index fadffc40ef..53d3bb3d4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb @@ -22,15 +22,16 @@ module Elasticsearch module API module Esql module Actions - # Executes an ESQL request asynchronously + # Run an async ES|QL query # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. + # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the entire query will fail if there are any failures. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-async-query-api.html # def async_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb new file mode 100644 index 0000000000..d4819a78b9 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb @@ -0,0 +1,60 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Esql + module Actions + # Delete an async ES|QL query + # + # @option arguments [String] :id The async query ID + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-async-query-delete-api.html + # + def async_query_delete(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_delete' } + + defined_params = [:id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _id = arguments.delete(:id) + + method = Elasticsearch::API::HTTP_DELETE + path = "_query/async/#{Utils.__listify(_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb index 4d59504018..aaa3dd8ca0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb @@ -22,15 +22,16 @@ module Elasticsearch module API module Esql module Actions - # Retrieves the results of a previously submitted async query request given its ID. + # Get async ES|QL query results # # @option arguments [String] :id The async query ID + # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @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 # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-get-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-async-query-get-api.html # def async_query_get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb new file mode 100644 index 0000000000..59bae9be1d --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb @@ -0,0 +1,60 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Esql + module Actions + # Stop async ES|QL query + # + # @option arguments [String] :id The async query ID + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-async-query-stop-api.html + # + def async_query_stop(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_stop' } + + defined_params = [:id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _id = arguments.delete(:id) + + method = Elasticsearch::API::HTTP_POST + path = "_query/async/#{Utils.__listify(_id)}/stop" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb index 0d722a7f72..53720942bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb @@ -22,15 +22,16 @@ module Elasticsearch module API module Esql module Actions - # Executes an ESQL request + # Run an ES|QL query # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. + # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the entire query will fail if there are any failures. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-rest.html # def query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.query' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb index aaf756abe1..c0acfc2652 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about whether a document exists in an index. + # Check a document # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index @@ -37,7 +37,7 @@ module Actions # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html # def exists(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'exists' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb index ce01cb5e22..8581f8a5db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about whether a document source exists in an index. + # Check for a document source # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html # def exists_source(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'exists_source' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb index b78f9160a5..ce87a58c03 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about why a specific matches (or doesn't match) a query. + # Explain a document match result # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index @@ -40,7 +40,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The query definition using the Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-explain.html # def explain(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'explain' } 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 65c71bc792..8a3610e3ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Features module Actions - # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + # Get the features # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-features-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-features-api.html # def get_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'features.get_features' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb index 63ea0c5e85..cb475be2b5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Features module Actions - # Resets the internal state of features, usually by deleting system indices + # Reset the features # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/reset-features-api.html # def reset_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'features.reset_features' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb index 0ad6237bb3..54af835163 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns the information about the capabilities of fields among multiple indices. + # Get the field capabilities # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :fields A comma-separated list of field names @@ -35,7 +35,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An index filter specified with the Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-field-caps.html # def field_caps(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'field_caps' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb index 8ff603ad77..7520ec5c58 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Deletes a secret stored by Fleet. + # Deletes a secret stored by Fleet # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb index f00f51e05c..bbf72e46b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Retrieves a secret stored by Fleet. + # Retrieves a secret stored by Fleet # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb index 7768f2c53d..1e8f2364bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. + # Get global checkpoints # # @option arguments [String] :index The name of the index. # @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :timeout Timeout to wait for global checkpoint to advance # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-global-checkpoints.html # def global_checkpoints(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.global_checkpoints' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb index d80bbed755..8fbb576a63 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + # Executes several fleet searches with a single API request # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb index 340520db70..d51b48519e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Creates a secret stored by Fleet. + # Creates a secret stored by Fleet # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb index d3f67b21dc..13e07bf6ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + # The purpose of the fleet search api is to provide a search api where the search will only be executed # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb index 3b956abf07..bfb8f2586a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns a document. + # Get a document by its ID # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index @@ -38,7 +38,7 @@ module Actions # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb index d1a4baf476..180828b772 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Returns a script. + # Get a script or search template # # @option arguments [String] :id Script ID # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-stored-script-api.html # def get_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb index 845762ab86..2c7f093a46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns all script contexts. + # Get script contexts # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-contexts-api.html # def get_script_context(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script_context' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb index d8f9d8d77b..fdb86bc4db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns available script types, languages and contexts + # Get script languages # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-languages-api.html # def get_script_languages(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script_languages' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index e66b8c5e6c..518da06b9e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns the source of a document. + # Get a document's source # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html # def get_source(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_source' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb index 64306ce433..2a605045ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Graph module Actions - # Explore extracted and summarized information about the documents and terms in an index. + # Explore graph analytics # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :routing Specific routing value @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Graph Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/graph-explore-api.html # def explore(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'graph.explore' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb index 7849b26638..ecc091b939 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns the health of the cluster. + # Get the cluster health # # @option arguments [String] :feature A feature of the cluster, as returned by the top-level health API # @option arguments [Time] :timeout Explicit operation timeout @@ -29,7 +29,7 @@ module Actions # @option arguments [Integer] :size Limit the number of affected resources the health API returns # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/health-api.html # def health_report(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'health_report' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index d691aa13d9..03c43c6a71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Creates or updates a document in an index. + # Create or update a document in an index # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index @@ -37,10 +37,11 @@ module Actions # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with # @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false # @option arguments [Boolean] :require_data_stream When true, requires the destination to be a data stream (existing or to-be-created). Default is false + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The document (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html # def index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'index' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb index 824ecf28ed..2475615939 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb @@ -22,12 +22,14 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. + # Delete a lifecycle policy # # @option arguments [String] :policy The name of the index lifecycle policy + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-delete-lifecycle.html # def delete_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.delete_lifecycle' } @@ -48,7 +50,7 @@ def delete_lifecycle(arguments = {}) method = Elasticsearch::API::HTTP_DELETE path = "_ilm/policy/#{Utils.__listify(_policy)}" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) 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 5480ccb531..c1bd7196bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb @@ -22,14 +22,15 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. + # Explain the lifecycle state # # @option arguments [String] :index The name of the index to explain # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-explain-lifecycle.html # def explain_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.explain_lifecycle' } 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 dc898b2659..7716b773f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb @@ -22,12 +22,14 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Returns the specified policy definition. Includes the policy version and last modified date. + # Get lifecycle policies # # @option arguments [String] :policy The name of the index lifecycle policy + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-get-lifecycle.html # def get_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.get_lifecycle' } @@ -50,7 +52,7 @@ def get_lifecycle(arguments = {}) else '_ilm/policy' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb index 0cf68bc5c1..ebf9a79821 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retrieves the current index lifecycle management (ILM) status. + # Get the ILM status # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-get-status.html # def get_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.get_status' } 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 c75e5a8bb0..2fc1b06284 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing + # Migrate to data tiers routing # # @option arguments [Boolean] :dry_run If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false # @option arguments [Hash] :headers Custom HTTP headers # @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") # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-migrate-to-data-tiers.html # def migrate_to_data_tiers(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.migrate_to_data_tiers' } 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 212cb8efc6..bd5c58d033 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Manually moves an index into the specified step and executes that step. + # Move to a lifecycle step # # @option arguments [String] :index The name of the index whose lifecycle step is to change # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The new lifecycle step to move to # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-move-to-step.html # def move_to_step(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.move_to_step' } 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 da5fcecdfc..2f7a680055 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb @@ -22,13 +22,15 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Creates a lifecycle policy + # Create or update a lifecycle policy # # @option arguments [String] :policy The name of the index lifecycle policy + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The lifecycle policy definition to register # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-put-lifecycle.html # def put_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.put_lifecycle' } @@ -49,7 +51,7 @@ def put_lifecycle(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = "_ilm/policy/#{Utils.__listify(_policy)}" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) 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 96eaed6977..aef6b6b7d9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Removes the assigned lifecycle policy and stops managing the specified index + # Remove policies from an index # # @option arguments [String] :index The name of the index to remove policy on # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-remove-policy.html # def remove_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.remove_policy' } 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 61fbb1b173..3845d8e048 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retries executing the policy for an index that is in the ERROR step. + # Retry a policy # # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-retry-policy.html # def retry(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.retry' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb index 0f30639b52..943af594ad 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb @@ -22,11 +22,13 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Start the index lifecycle management (ILM) plugin. + # Start the ILM plugin # + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-start.html # def start(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.start' } @@ -38,7 +40,7 @@ def start(arguments = {}) method = Elasticsearch::API::HTTP_POST path = '_ilm/start' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb index 23e0761b67..68294988ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb @@ -22,11 +22,13 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + # Stop the ILM plugin # + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-stop.html # def stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.stop' } @@ -38,7 +40,7 @@ def stop(arguments = {}) method = Elasticsearch::API::HTTP_POST path = '_ilm/stop' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) 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 b04cfd2b68..3f16cc4c6c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Adds a block to an index. + # Add an index block # # @option arguments [List] :index A comma separated list of indices to add a block to # @option arguments [String] :block The block to add (one of read, write, read_only or metadata) @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index-modules-blocks.html#add-index-block # def add_block(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.add_block' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb index 00e736136e..f9121ffa20 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Indices module Actions - # Performs the analysis process on a text and return the tokens breakdown of the text. + # Get tokens from text analysis # # @option arguments [String] :index The name of the index to scope the operation # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-analyze # def analyze(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.analyze' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb index 0e214b6e48..c365216806 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Clears all or specific caches for one or more indices. + # Clear the cache # # @option arguments [List] :index A comma-separated list of index name to limit the operation # @option arguments [Boolean] :fielddata Clear field data @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :request Clear request cache # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-clearcache.html # def clear_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.clear_cache' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb index fd336f75ee..b56203205e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Clones an index + # Clone an index # # @option arguments [String] :index The name of the source index to clone # @option arguments [String] :target The name of the target index to clone into @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clone-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-clone-index.html # def clone(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.clone' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb index e3533f1a27..64df55857f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Closes an index. + # Close an index # # @option arguments [List] :index A comma separated list of indices to close # @option arguments [Time] :timeout Explicit operation timeout @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-close.html # def close(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.close' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb index 0135beabd9..08bd36b2c1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Creates an index with optional settings and mappings. + # Create an index # # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns. @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the index (`settings` and `mappings`) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-create-index.html # def create(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.create' } 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 66da1e830c..8c61526a45 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Creates a data stream + # Create a data stream # # @option arguments [String] :name The name of the data stream # @option arguments [Time] :timeout Specify timeout for acknowledging the cluster state update # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-create-data-stream.html # def create_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.create_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb index 4d7087632d..9d1d240ca6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Indices module Actions - # Provides statistics on operations happening in a data stream. + # Get data stream stats # # @option arguments [List] :name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-stream-stats-api.html # def data_streams_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.data_streams_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index bb53aaa0cc..06397232b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes an index. + # Delete indices # # @option arguments [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices # @option arguments [Time] :timeout Explicit operation timeout @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-index.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete' } 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 abfd6ebed6..d9af1cf744 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes an alias. + # Delete an alias # # @option arguments [List] :index A comma-separated list of index names (supports wildcards); use `_all` for all indices # @option arguments [List] :name A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-alias.html # def delete_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb index f8b248bb2a..15cc639d33 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb @@ -22,11 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes the data stream lifecycle of the selected data streams. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Delete data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) @@ -34,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-delete-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-delete-lifecycle.html # def delete_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_lifecycle' } 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 c773bbc37a..56da37f23d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Deletes a data stream. + # Delete data streams # # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-data-stream.html # def delete_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb new file mode 100644 index 0000000000..ed420f5ca2 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb @@ -0,0 +1,63 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Indices + module Actions + # Deletes the data stream options of the selected data streams + # + # @option arguments [List] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams + # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [Time] :timeout Explicit timestamp for the document + # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html + # + def delete_data_stream_options(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream_options' } + + defined_params = [:name].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _name = arguments.delete(:name) + + method = Elasticsearch::API::HTTP_DELETE + path = "_data_stream/#{Utils.__listify(_name)}/_options" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb index e4e20fad6b..a55e8c4bdd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Deletes an index template. + # Delete an index template # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-template.html # def delete_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_index_template' } 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 ec10ca44aa..b3e0775ca9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Deletes an index template. + # Delete a legacy index template # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-template-v1.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-template-v1.html # def delete_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb index cd3308a1b5..aa2e38299a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Analyzes the disk usage of each field of an index or data stream + # Analyze the index disk usage # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -36,7 +36,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-disk-usage.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-disk-usage.html # def disk_usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.disk_usage' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb index b08ac1ecee..a660f5b8e4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The downsampling configuration (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-downsample-data-stream.html # def downsample(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.downsample' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb index 34e9b34a54..a1abe49e4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index exists. + # Check indices # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-exists.html # def exists(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists' } 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 597a9e010d..a0da58aa06 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular alias exists. + # Check aliases # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [List] :index A comma-separated list of index names to filter aliases @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias # def exists_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb index b7c2fbb12a..276a5c2d7e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index template exists. + # Check index templates # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-index-template # def exists_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_index_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb index 3d1defc508..f7d013f5ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index template exists. + # Check existence of index templates # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-template-exists-v1.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-template-exists-v1.html # def exists_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb index c155af80e9..1fcbfe53f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb @@ -22,18 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get the status for a data stream lifecycle # # @option arguments [String] :index The name of the index to explain # @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-explain-lifecycle.html # def explain_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.explain_data_lifecycle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb index aaac263510..365754eb1f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns the field usage stats for each field of an index + # Get field usage stats # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -35,7 +35,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/field-usage-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/field-usage-stats.html # def field_usage_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.field_usage_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb index 0e92583735..7db51d28d1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Performs the flush operation on one or more indices. + # Flush data streams or indices # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) @@ -32,7 +32,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-flush.html # def flush(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.flush' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index 6ea744edc3..607f573be3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Performs the force merge operation on one or more indices. + # Force a merge # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true) @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-forcemerge.html # def forcemerge(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.forcemerge' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb index 33836e4e6c..9a42b4110a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about one or more indices. + # Get index information # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -35,7 +35,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-index.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get' } 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 4e598e33a8..0f371c7807 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns an alias. + # Get aliases # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [List] :index A comma-separated list of index names to filter aliases @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-alias.html # def get_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb index 3661340ee5..24f6cdcd84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb @@ -22,11 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns the data stream lifecycle of the selected data streams. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) @@ -34,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-get-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-get-lifecycle.html # def get_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_lifecycle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb new file mode 100644 index 0000000000..06ae4f5b9d --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb @@ -0,0 +1,50 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Indices + module Actions + # Get data stream lifecycle stats + # + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-get-lifecycle-stats.html + # + def get_data_lifecycle_stats(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_lifecycle_stats' } + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + method = Elasticsearch::API::HTTP_GET + path = '_lifecycle/stats' + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb index 5e1ff6ff08..0023cd639a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns data streams. + # Get data streams # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :verbose Whether the maximum timestamp for each data stream should be calculated and returned (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-data-stream.html # def get_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb new file mode 100644 index 0000000000..e9c80b071d --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb @@ -0,0 +1,62 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Indices + module Actions + # Returns the data stream options of the selected data streams + # + # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams + # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html + # + def get_data_stream_options(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_options' } + + defined_params = [:name].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _name = arguments.delete(:name) + + method = Elasticsearch::API::HTTP_GET + path = "_data_stream/#{Utils.__listify(_name)}/_options" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb new file mode 100644 index 0000000000..b973711fa5 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb @@ -0,0 +1,61 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Indices + module Actions + # Gets a data stream's settings + # + # @option arguments [String] :name Comma-separated list of data streams or data stream patterns + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # + def get_data_stream_settings(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_settings' } + + defined_params = [:name].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _name = arguments.delete(:name) + + method = Elasticsearch::API::HTTP_GET + path = "_data_stream/#{Utils.__listify(_name)}/_settings" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb index f4aad0249d..86047b8ae4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns mapping for one or more fields. + # Get mapping definitions # # @option arguments [List] :fields A comma-separated list of fields # @option arguments [List] :index A comma-separated list of index names @@ -33,7 +33,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-field-mapping.html # def get_field_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_field_mapping' } 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 620537f86c..6629a43e2d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns an index template. + # Get index templates # # @option arguments [String] :name A pattern that returned template names must match # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the index template (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-template.html # def get_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_index_template' } 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 8160fd20b3..b089fe0b71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns mappings for one or more indices. + # Get mapping definitions # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-mapping.html # def get_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_mapping' } 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 a388991927..b641761c92 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns settings for one or more indices. + # Get index settings # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :name The name of the settings that should be included @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-settings.html # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_settings' } 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 2a19f7f48b..37592a1cde 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns an index template. + # Get legacy index templates # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template-v1.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-template-v1.html # def get_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_template' } 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 7b70036ced..8117803127 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Migrates an alias to a data stream + # Convert an index alias to a data stream # # @option arguments [String] :name The name of the alias to migrate # @option arguments [Time] :timeout Specify timeout for acknowledging the cluster state update # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-migrate-to-data-stream # def migrate_to_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_to_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb index eb8dedc08e..7b233b5da6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Indices module Actions - # Modifies a data stream + # Update data streams # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data stream modifications (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-modify-data-stream # def modify_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.modify_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index b1b6844cc0..8b98335eb4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Opens an index. + # Open a closed index # # @option arguments [List] :index A comma separated list of indices to open # @option arguments [Time] :timeout Explicit operation timeout @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-open-close.html # def open(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.open' } 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 1a55479ee6..046e248d54 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Indices module Actions - # Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + # Promote a data stream # # @option arguments [String] :name The name of the data stream # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-promote-data-stream # def promote_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.promote_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb index d18dce3386..0b9b228aaa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Creates or updates an alias. + # Create or update an alias # # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. # @option arguments [String] :name The name of the alias to be created or updated @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter` # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-alias # def put_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb index f64a67418b..f3636fef9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb @@ -22,11 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates the data stream lifecycle of the selected data streams. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams whose lifecycle will be updated; use `*` to set the lifecycle to all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) @@ -35,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data stream lifecycle configuration that consist of the data retention # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-put-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-data-lifecycle # def put_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_lifecycle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb new file mode 100644 index 0000000000..4ef36f7dc0 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb @@ -0,0 +1,64 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Indices + module Actions + # Updates the data stream options of the selected data streams + # + # @option arguments [List] :name A comma-separated list of data streams whose options will be updated; use `*` to set the options to all data streams + # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [Time] :timeout Explicit timestamp for the document + # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The data stream options configuration that consist of the failure store configuration + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html + # + def put_data_stream_options(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_options' } + + defined_params = [:name].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _name = arguments.delete(:name) + + method = Elasticsearch::API::HTTP_PUT + path = "_data_stream/#{Utils.__listify(_name)}/_options" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb similarity index 61% rename from elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb rename to elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb index 1a342f408f..0f32c32df4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb @@ -20,41 +20,40 @@ # module Elasticsearch module API - module Connector + module Indices module Actions - # Updates the stats of last sync in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Updates a data stream's settings # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @option arguments [String] :name Comma-separated list of data streams or data stream patterns + # @option arguments [Boolean] :dry_run Whether this request should only be a dry run rather than actually applying settings + # @option arguments [Time] :timeout Period to wait for a response + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Object with stats related to the last connector sync run. (*Required*) + # @option arguments [Hash] :body The data stream settings to be updated (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-last-sync-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html # - def last_sync(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'connector.last_sync' } + def put_data_stream_settings(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_settings' } - defined_params = [:connector_id].each_with_object({}) do |variable, set_variables| + defined_params = [:name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] - raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id] + raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) - _connector_id = arguments.delete(:connector_id) + _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_last_sync" - params = {} + path = "_data_stream/#{Utils.__listify(_name)}/_settings" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) 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 061f55edbc..454defd8e9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Creates or updates an index template. + # Create or update an index template # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The template definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-index-template # def put_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_index_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb index c0c85affa7..bb02fee853 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates the index mappings. + # Update field mappings # # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. # @option arguments [Time] :timeout Explicit operation timeout @@ -34,7 +34,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The mapping definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-put-mapping.html # def put_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_mapping' } 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 887c817ab4..63cf8fadf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates the index settings. + # Update index settings # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Time] :master_timeout Specify timeout for connection to master @@ -36,7 +36,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The index settings to be updated (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-update-settings.html # def put_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_settings' } 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 93888e5236..37407058d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb @@ -22,16 +22,17 @@ module Elasticsearch module API module Indices module Actions - # Creates or updates an index template. + # Create or update a legacy index template # # @option arguments [String] :name The name of the template # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) # @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 # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The template definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-templates-v1.html # def put_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index c599681e96..ba12b93e08 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -22,14 +22,17 @@ module Elasticsearch module API module Indices module Actions - # Returns information about ongoing index shard recoveries. + # Get index recovery information # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :detailed Whether to display detailed information about shard recovery # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going + # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) + # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-recovery.html # def recovery(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.recovery' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb index 732d10d415..a560c7ac9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Performs the refresh operation in one or more indices. + # Refresh an index # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -30,7 +30,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html # def refresh(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.refresh' } 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 3fb1dcf414..694082818c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Reloads an index's search analyzers and their resources. + # Reload search analyzers # # @option arguments [List] :index A comma-separated list of index names to reload analyzers for # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :resource changed resource to reload analyzers from if applicable # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-reload-analyzers.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html # def reload_search_analyzers(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.reload_search_analyzers' } 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 9f399ef567..ed06dc346f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb @@ -22,16 +22,17 @@ module Elasticsearch module API module Indices module Actions - # Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. + # Resolve the cluster # # @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled - # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression. + # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression. + # @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). Only allowed when providing an index expression. + # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression. (options: open, closed, hidden, none, all) + # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-cluster-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html # def resolve_cluster(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_cluster' } @@ -41,8 +42,6 @@ def resolve_cluster(arguments = {}) end request_opts[:defined_params] = defined_params unless defined_params.empty? - raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] - arguments = arguments.clone headers = arguments.delete(:headers) || {} @@ -51,7 +50,11 @@ def resolve_cluster(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET - path = "_resolve/cluster/#{Utils.__listify(_name)}" + path = if _name + "_resolve/cluster/#{Utils.__listify(_name)}" + else + '_resolve/cluster' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( 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 9c6e38013d..61994fce66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about any matching indices, aliases, and data streams + # Resolve indices # # @option arguments [List] :name A comma-separated list of names or wildcard expressions # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-index-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-index-api.html # def resolve_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_index' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb index 7ddd3b5df0..000e8d1533 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb @@ -22,8 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates an alias to point to a new index when the existing index - # is considered to be too large or too old. + # Roll over to a new index # # @option arguments [String] :alias The name of the alias to rollover # @option arguments [String] :new_index The name of the rollover index @@ -32,11 +31,10 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns. # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams. - # @option arguments [Boolean] :target_failure_store If set to true, the rollover action will be applied on the failure store of the data stream. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The conditions that needs to be met for executing rollover # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-rollover-index.html # def rollover(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.rollover' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb index b29bb72c65..518ae3ebb8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Provides low-level information about segments in a Lucene index. + # Get index segments # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene. *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-segments.html # def segments(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.segments' } 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 04000d4f7e..35579a4fee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Provides store information for shard copies of indices. + # Get index shard stores # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all) @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-shards-stores.html # def shard_stores(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.shard_stores' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb index 00a28b5ec1..07bdfabba6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Allow to shrink an existing index into a new index with fewer primary shards. + # Shrink an index # # @option arguments [String] :index The name of the source index to shrink # @option arguments [String] :target The name of the target index to shrink into @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shrink-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-shrink-index.html # def shrink(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.shrink' } 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 3817f9f5ca..dc575ca509 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Simulate matching the given index name against the index templates in the system + # Simulate an index # # @option arguments [String] :name The name of the index (it must be a concrete index name) # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body New index template definition, which will be included in the simulation, as if it already exists in the system # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-simulate-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-simulate-index.html # def simulate_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_index_template' } 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 afb1e8306f..95718a80cc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Simulate resolving the given template name or body + # Simulate an index template # # @option arguments [String] :name The name of the index template # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-simulate-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-simulate-template.html # def simulate_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb index 4bd7412a9c..329f45810c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Allows you to split an existing index into a new index with more primary shards. + # Split an index # # @option arguments [String] :index The name of the source index to split # @option arguments [String] :target The name of the target index to split into @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-split-index.html # def split(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.split' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index c054f9434a..ac6a27236e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Provides statistics on operations happening in an index. + # Get index statistics # # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -37,7 +37,7 @@ module Actions # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-stats.html # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb index 6263d97b2b..9883b21a61 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. + # Unfreeze an index # # @option arguments [String] :index The name of the index to unfreeze # @option arguments [Time] :timeout Explicit operation timeout @@ -38,7 +38,7 @@ module Actions # Deprecated since version 7.14.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/unfreeze-index-api.html # def unfreeze(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.unfreeze' } 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 e7178802bf..fa83b83f50 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Updates index aliases. + # Create or update an alias # # @option arguments [Time] :timeout Request timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The definition of `actions` to perform (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-aliases # def update_aliases(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.update_aliases' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb index 03a22a7bc7..3365d66629 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Allows a user to validate a potentially expensive query without executing it. + # Validate a query # # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :explain Return detailed information about the error @@ -40,7 +40,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The query definition specified with the Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-validate.html # def validate_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.validate_query' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb new file mode 100644 index 0000000000..070020b7e7 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb @@ -0,0 +1,61 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Perform chat completion inference + # + # @option arguments [String] :inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference payload + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/chat-completion-inference-api.html + # + def chat_completion_unified(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.chat_completion_unified' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/chat_completion/#{Utils.__listify(_inference_id)}/_stream" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb new file mode 100644 index 0000000000..909928be71 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb @@ -0,0 +1,61 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Perform completion inference on the service + # + # @option arguments [String] :inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference payload + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-inference-api.html + # + def completion(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.completion' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/completion/#{Utils.__listify(_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb index f9186d3c76..692bff970f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb @@ -23,10 +23,6 @@ module API module Inference module Actions # Delete an inference endpoint - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. # # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type @@ -34,7 +30,7 @@ module Actions # @option arguments [Boolean] :force If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields). # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-inference-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-inference-api.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb index cb227aa9b2..734517714c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb @@ -23,16 +23,12 @@ module API module Inference module Actions # Get an inference endpoint - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. # # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-inference-api.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb index de5e7b797c..788c753f43 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb @@ -22,18 +22,14 @@ module Elasticsearch module API module Inference module Actions - # Perform inference - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Perform inference on the service # # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference payload # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/post-inference-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-inference-api.html # def inference(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.inference' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb index 9d485bcd17..ff3d3613b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb @@ -22,18 +22,14 @@ module Elasticsearch module API module Inference module Actions - # Configure an inference endpoint for use in the Inference API - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create an inference endpoint # # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference endpoint's task and service settings # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-inference-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-inference-api.html # def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.put' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb new file mode 100644 index 0000000000..17af7553fa --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an AlibabaCloud AI Search inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :alibabacloud_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-alibabacloud-ai-search.html + # + def put_alibabacloud(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_alibabacloud' } + + defined_params = %i[task_type alibabacloud_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:alibabacloud_inference_id] + raise ArgumentError, + "Required argument 'alibabacloud_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _alibabacloud_inference_id = arguments.delete(:alibabacloud_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_alibabacloud_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb new file mode 100644 index 0000000000..7a35148a18 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an Amazon Bedrock inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :amazonbedrock_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-amazon-bedrock.html + # + def put_amazonbedrock(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_amazonbedrock' } + + defined_params = %i[task_type amazonbedrock_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:amazonbedrock_inference_id] + raise ArgumentError, + "Required argument 'amazonbedrock_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _amazonbedrock_inference_id = arguments.delete(:amazonbedrock_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_amazonbedrock_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb new file mode 100644 index 0000000000..ee767ac727 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an Amazon SageMaker inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :amazonsagemaker_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonsagemaker + # + def put_amazonsagemaker(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_amazonsagemaker' } + + defined_params = %i[task_type amazonsagemaker_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:amazonsagemaker_inference_id] + raise ArgumentError, + "Required argument 'amazonsagemaker_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _amazonsagemaker_inference_id = arguments.delete(:amazonsagemaker_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_amazonsagemaker_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb new file mode 100644 index 0000000000..80997103f3 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an Anthropic inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :anthropic_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-anthropic.html + # + def put_anthropic(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_anthropic' } + + defined_params = %i[task_type anthropic_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:anthropic_inference_id] + raise ArgumentError, + "Required argument 'anthropic_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _anthropic_inference_id = arguments.delete(:anthropic_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_anthropic_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb new file mode 100644 index 0000000000..2639a8d929 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an Azure AI studio inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :azureaistudio_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-azure-ai-studio.html + # + def put_azureaistudio(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureaistudio' } + + defined_params = %i[task_type azureaistudio_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:azureaistudio_inference_id] + raise ArgumentError, + "Required argument 'azureaistudio_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _azureaistudio_inference_id = arguments.delete(:azureaistudio_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_azureaistudio_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb new file mode 100644 index 0000000000..dd03ebe31c --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an Azure OpenAI inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :azureopenai_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-azure-openai.html + # + def put_azureopenai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureopenai' } + + defined_params = %i[task_type azureopenai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:azureopenai_inference_id] + raise ArgumentError, + "Required argument 'azureopenai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _azureopenai_inference_id = arguments.delete(:azureopenai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_azureopenai_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb new file mode 100644 index 0000000000..b244f39afe --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb @@ -0,0 +1,65 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a Cohere inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :cohere_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-cohere.html + # + def put_cohere(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_cohere' } + + defined_params = %i[task_type cohere_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + raise ArgumentError, "Required argument 'cohere_inference_id' missing" unless arguments[:cohere_inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _cohere_inference_id = arguments.delete(:cohere_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_cohere_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb new file mode 100644 index 0000000000..be8c3faa04 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb @@ -0,0 +1,65 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a custom inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :custom_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom + # + def put_custom(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_custom' } + + defined_params = %i[task_type custom_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + raise ArgumentError, "Required argument 'custom_inference_id' missing" unless arguments[:custom_inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _custom_inference_id = arguments.delete(:custom_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_custom_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb new file mode 100644 index 0000000000..a8ecff6a19 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a DeepSeek inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :deepseek_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-deepseek.html + # + def put_deepseek(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_deepseek' } + + defined_params = %i[task_type deepseek_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:deepseek_inference_id] + raise ArgumentError, + "Required argument 'deepseek_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _deepseek_inference_id = arguments.delete(:deepseek_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_deepseek_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb new file mode 100644 index 0000000000..230bdcdc79 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an Elasticsearch inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :elasticsearch_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-elasticsearch.html + # + def put_elasticsearch(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elasticsearch' } + + defined_params = %i[task_type elasticsearch_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:elasticsearch_inference_id] + raise ArgumentError, + "Required argument 'elasticsearch_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _elasticsearch_inference_id = arguments.delete(:elasticsearch_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_elasticsearch_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb new file mode 100644 index 0000000000..b59195c23b --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb @@ -0,0 +1,65 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an ELSER inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :elser_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-elser.html + # + def put_elser(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elser' } + + defined_params = %i[task_type elser_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + raise ArgumentError, "Required argument 'elser_inference_id' missing" unless arguments[:elser_inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _elser_inference_id = arguments.delete(:elser_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_elser_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb new file mode 100644 index 0000000000..f93366fa1d --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an Google AI Studio inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :googleaistudio_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-google-ai-studio.html + # + def put_googleaistudio(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googleaistudio' } + + defined_params = %i[task_type googleaistudio_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:googleaistudio_inference_id] + raise ArgumentError, + "Required argument 'googleaistudio_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _googleaistudio_inference_id = arguments.delete(:googleaistudio_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_googleaistudio_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb new file mode 100644 index 0000000000..ddec4dfb62 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a Google Vertex AI inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :googlevertexai_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-google-vertex-ai.html + # + def put_googlevertexai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googlevertexai' } + + defined_params = %i[task_type googlevertexai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:googlevertexai_inference_id] + raise ArgumentError, + "Required argument 'googlevertexai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _googlevertexai_inference_id = arguments.delete(:googlevertexai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_googlevertexai_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb new file mode 100644 index 0000000000..e8afe712f0 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a Hugging Face inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :huggingface_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-hugging-face.html + # + def put_hugging_face(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_hugging_face' } + + defined_params = %i[task_type huggingface_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:huggingface_inference_id] + raise ArgumentError, + "Required argument 'huggingface_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _huggingface_inference_id = arguments.delete(:huggingface_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_huggingface_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb new file mode 100644 index 0000000000..b36c30e7c0 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb @@ -0,0 +1,65 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an JinaAI inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :jinaai_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-jinaai.html + # + def put_jinaai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_jinaai' } + + defined_params = %i[task_type jinaai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + raise ArgumentError, "Required argument 'jinaai_inference_id' missing" unless arguments[:jinaai_inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _jinaai_inference_id = arguments.delete(:jinaai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_jinaai_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb new file mode 100644 index 0000000000..a39e26b720 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a Mistral inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :mistral_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-mistral.html + # + def put_mistral(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_mistral' } + + defined_params = %i[task_type mistral_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:mistral_inference_id] + raise ArgumentError, + "Required argument 'mistral_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _mistral_inference_id = arguments.delete(:mistral_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_mistral_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb new file mode 100644 index 0000000000..09152c0921 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb @@ -0,0 +1,65 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create an OpenAI inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :openai_inference_id The inference ID + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-openai.html + # + def put_openai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_openai' } + + defined_params = %i[task_type openai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + raise ArgumentError, "Required argument 'openai_inference_id' missing" unless arguments[:openai_inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _openai_inference_id = arguments.delete(:openai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_openai_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb new file mode 100644 index 0000000000..06b2173169 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a VoyageAI inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :voyageai_inference_id The inference ID + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-voyageai.html + # + def put_voyageai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_voyageai' } + + defined_params = %i[task_type voyageai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:voyageai_inference_id] + raise ArgumentError, + "Required argument 'voyageai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _voyageai_inference_id = arguments.delete(:voyageai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_voyageai_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb new file mode 100644 index 0000000000..1baa54abc6 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb @@ -0,0 +1,69 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Create a Watsonx inference endpoint + # + # @option arguments [String] :task_type The task type + # @option arguments [String] :watsonx_inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-watsonx-ai.html + # + def put_watsonx(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_watsonx' } + + defined_params = %i[task_type watsonx_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:watsonx_inference_id] + raise ArgumentError, + "Required argument 'watsonx_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _watsonx_inference_id = arguments.delete(:watsonx_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_watsonx_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb new file mode 100644 index 0000000000..990be7f70d --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb @@ -0,0 +1,61 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Perform reranking inference on the service + # + # @option arguments [String] :inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference payload + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-inference-api.html + # + def rerank(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.rerank' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/rerank/#{Utils.__listify(_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb new file mode 100644 index 0000000000..c7057ad250 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb @@ -0,0 +1,61 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Perform sparse embedding inference on the service + # + # @option arguments [String] :inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference payload + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-inference-api.html + # + def sparse_embedding(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.sparse_embedding' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/sparse_embedding/#{Utils.__listify(_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb new file mode 100644 index 0000000000..699de09384 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb @@ -0,0 +1,61 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Perform streaming inference + # + # @option arguments [String] :inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference payload + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stream-inference-api.html + # + def stream_completion(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.stream_completion' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/completion/#{Utils.__listify(_inference_id)}/_stream" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb new file mode 100644 index 0000000000..ae93b8a118 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb @@ -0,0 +1,61 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Perform text embedding inference on the service + # + # @option arguments [String] :inference_id The inference Id + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference payload + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-inference-api.html + # + def text_embedding(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.text_embedding' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/text_embedding/#{Utils.__listify(_inference_id)}" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb new file mode 100644 index 0000000000..11a5285239 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb @@ -0,0 +1,68 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Inference + module Actions + # Update an inference endpoint + # + # @option arguments [String] :inference_id The inference Id + # @option arguments [String] :task_type The task type + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The inference endpoint's task and service settings + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-inference-api.html + # + def update(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.update' } + + defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + _task_type = arguments.delete(:task_type) + + method = Elasticsearch::API::HTTP_PUT + path = if _task_type && _inference_id + "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}/_update" + else + "_inference/#{Utils.__listify(_inference_id)}/_update" + end + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb index ca00f362a8..0ed8ae279f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns basic information about the cluster. + # Get cluster info # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rest-api-root.html # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'info' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb index 9a75e8c8ec..7e20dc549e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb @@ -22,12 +22,14 @@ module Elasticsearch module API module Ingest module Actions - # Deletes a geoip database configuration + # Delete GeoIP database configurations # # @option arguments [List] :id A comma-separated list of geoip database configurations to delete + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/TODO.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-delete-geoip-database # def delete_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_geoip_database' } @@ -48,7 +50,7 @@ def delete_geoip_database(arguments = {}) method = Elasticsearch::API::HTTP_DELETE path = "_ingest/geoip/database/#{Utils.__listify(_id)}" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb new file mode 100644 index 0000000000..2702fb3dd4 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb @@ -0,0 +1,62 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Ingest + module Actions + # Delete IP geolocation database configurations + # + # @option arguments [List] :id A comma-separated list of ip location database configurations to delete + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-ip-location-database-api.html + # + def delete_ip_location_database(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_ip_location_database' } + + defined_params = [:id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _id = arguments.delete(:id) + + method = Elasticsearch::API::HTTP_DELETE + path = "_ingest/ip_location/database/#{Utils.__listify(_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb index d06a96d72f..702c7dc430 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Ingest module Actions - # Deletes a pipeline. + # Delete pipelines # # @option arguments [String] :id Pipeline ID # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-pipeline-api.html # def delete_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_pipeline' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb index 6764c9cd68..0a584eb391 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Ingest module Actions - # Returns statistical information about geoip databases + # Get GeoIP statistics # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-stats-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/geoip-processor.html # def geo_ip_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.geo_ip_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb index c6d73252d5..6625a51eac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Ingest module Actions - # Returns geoip database configuration. + # Get GeoIP database configurations # # @option arguments [List] :id A comma-separated list of geoip database configurations to get; use `*` to get all geoip database configurations # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/TODO.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-get-geoip-database # def get_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_geoip_database' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb new file mode 100644 index 0000000000..d0ead40b19 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb @@ -0,0 +1,62 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Ingest + module Actions + # Get IP geolocation database configurations + # + # @option arguments [List] :id A comma-separated list of ip location database configurations to get; use `*` to get all ip location database configurations + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-ip-location-database-api.html + # + def get_ip_location_database(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_ip_location_database' } + + defined_params = [:id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _id = arguments.delete(:id) + + method = Elasticsearch::API::HTTP_GET + path = if _id + "_ingest/ip_location/database/#{Utils.__listify(_id)}" + else + '_ingest/ip_location/database' + end + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb index 250ff6d312..2167c7c425 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Ingest module Actions - # Returns a pipeline. + # Get pipelines # # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-pipeline-api.html # def get_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_pipeline' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb index 6dbfa81bbc..5502c0b3eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Ingest module Actions - # Returns a list of the built-in patterns. + # Run a grok processor # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html#grok-processor-rest-get + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/grok-processor.html # def processor_grok(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.processor_grok' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb index e0db4adf5a..4e0e3ce687 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb @@ -22,13 +22,15 @@ module Elasticsearch module API module Ingest module Actions - # Puts the configuration for a geoip database to be downloaded + # Create or update a GeoIP database configuration # # @option arguments [String] :id The id of the database configuration + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The database configuration definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/TODO.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-put-geoip-database # def put_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_geoip_database' } @@ -50,7 +52,7 @@ def put_geoip_database(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = "_ingest/geoip/database/#{Utils.__listify(_id)}" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb new file mode 100644 index 0000000000..1651423548 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb @@ -0,0 +1,64 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Ingest + module Actions + # Create or update an IP geolocation database configuration + # + # @option arguments [String] :id The id of the database configuration + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The database configuration definition (*Required*) + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-ip-location-database-api.html + # + def put_ip_location_database(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_ip_location_database' } + + defined_params = [:id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _id = arguments.delete(:id) + + method = Elasticsearch::API::HTTP_PUT + path = "_ingest/ip_location/database/#{Utils.__listify(_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb index 0c626836e2..76aa156599 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Creates or updates a pipeline. + # Create or update a pipeline # # @option arguments [String] :id Pipeline ID # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The ingest definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ingest.html # def put_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_pipeline' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb index 8ea6e3c717..ec5536f6b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Ingest module Actions - # Allows to simulate a pipeline with example documents. + # Simulate a pipeline # # @option arguments [String] :id Pipeline ID # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The simulate definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/simulate-pipeline-api.html # def simulate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.simulate' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb index 8a94ed0529..9848e0d82f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Performs a kNN search. + # Run a knn search # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/knn-search-api.html # def knn_search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'knn_search' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb index b4a2a5fd9d..cc9933bd84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module License module Actions - # Deletes licensing information for the cluster + # Delete the license # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-license.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-license.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb index ee9dc42840..b4f60302ee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module License module Actions - # Retrieves licensing information for the cluster + # Get license information # # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :accept_enterprise Supported for backwards compatibility with 7.x. If this param is used it must be set to true *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-license.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-license.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb index 351df544dc..268c6f85e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module License module Actions - # Retrieves information about the status of the basic license. + # Get the basic license status # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-basic-status.html # def get_basic_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get_basic_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb index e611a4570c..2dde16fecc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module License module Actions - # Retrieves information about the status of the trial license. + # Get the trial status # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trial-status.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-trial-status.html # def get_trial_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get_trial_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb index 54a72d52e3..60791c5807 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # Updates the license for the cluster. + # Update the license # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Time] :master_timeout Timeout for processing on master node @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body licenses to be installed # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-license.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-license-post # def post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb index b95eb10bf9..37a9ddaace 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module License module Actions - # Starts an indefinite basic license. + # Start a basic license # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-basic.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-basic.html # def post_start_basic(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_basic' } 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 4a3a20ae6c..3fa672d7fd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb @@ -22,15 +22,14 @@ module Elasticsearch module API module License module Actions - # starts a limited time trial license. + # Start a trial # # @option arguments [String] :type The type of trial license to generate (default: "trial") # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Time] :master_timeout Timeout for processing on master node - # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-trial.html # def post_start_trial(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_trial' } 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 3b8a16c6d9..68a8ec4547 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Logstash module Actions - # Deletes Logstash Pipelines used by Central Management + # Delete a Logstash pipeline # # @option arguments [String] :id The ID of the Pipeline # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/logstash-api-delete-pipeline.html # def delete_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'logstash.delete_pipeline' } 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 eaed065ef7..250b6974e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Logstash module Actions - # Retrieves Logstash Pipelines used by Central Management + # Get Logstash pipelines # # @option arguments [String] :id A comma-separated list of Pipeline IDs # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/logstash-api-get-pipeline.html # def get_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'logstash.get_pipeline' } 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 4e51cb3b13..6691fa2fb8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Logstash module Actions - # Adds and updates Logstash Pipelines used for Central Management + # Create or update a Logstash pipeline # # @option arguments [String] :id The ID of the Pipeline # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The Pipeline to add or update (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/logstash-api-put-pipeline.html # def put_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'logstash.put_pipeline' } 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 24d3aa5fc1..9a86d2bccc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Clear the cached results from a trained model deployment + # Clear trained model deployment cache # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-trained-model-deployment-cache.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-trained-model-deployment-cache.html # def clear_trained_model_deployment_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.clear_trained_model_deployment_cache' } 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 5683ec5644..f8ad22bad3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. + # Close anomaly detection jobs # # @option arguments [String] :job_id The name of the job to close # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The URL params optionally sent in the body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-close-job.html # def close_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.close_job' } 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 196d6e25b1..5e7aa155a3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes a calendar. + # Delete a calendar # # @option arguments [String] :calendar_id The ID of the calendar to delete # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-calendar.html # def delete_calendar(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_calendar' } 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 2e9d83e657..e0c0b6f01f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes scheduled events from a calendar. + # Delete events from a calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :event_id The ID of the event to remove from the calendar # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-calendar-event.html # def delete_calendar_event(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_calendar_event' } 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 f13bc4a282..897b9a6c4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes anomaly detection jobs from a calendar. + # Delete anomaly jobs from a calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :job_id The ID of the job to remove from the calendar # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-calendar-job.html # def delete_calendar_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_calendar_job' } 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 3bb2df5542..cc5aaa1664 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing data frame analytics job. + # Delete a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to delete # @option arguments [Boolean] :force True if the job should be forcefully deleted # @option arguments [Time] :timeout Controls the time to wait until a job is deleted. Defaults to 1 minute # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-dfanalytics.html # def delete_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_data_frame_analytics' } 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 d8778a21b3..b1ee1dfd6d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing datafeed. + # Delete a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to delete # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-datafeed.html # def delete_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_datafeed' } 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 5d9f381d1d..e6646d48b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes expired and unused machine learning data. + # Delete expired ML data # # @option arguments [String] :job_id The ID of the job(s) to perform expired data hygiene for # @option arguments [Number] :requests_per_second The desired requests per second for the deletion processes. @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body deleting expired data parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-expired-data.html # def delete_expired_data(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_expired_data' } 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 1079e0b75d..3cefdafe66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes a filter. + # Delete a filter # # @option arguments [String] :filter_id The ID of the filter to delete # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-filter.html # def delete_filter(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_filter' } 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 0a0d52aab3..cece5a628a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes forecasts from a machine learning job. + # Delete forecasts from a job # # @option arguments [String] :job_id The ID of the job from which to delete forecasts # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all` @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :timeout Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-forecast.html # def delete_forecast(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_forecast' } 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 7ae7b88f3f..3424c31cf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing anomaly detection job. + # Delete an anomaly detection job # # @option arguments [String] :job_id The ID of the job to delete # @option arguments [Boolean] :force True if the job should be forcefully deleted @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-job.html # def delete_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_job' } 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 85cb5b61f7..9d0e9babdd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing model snapshot. + # Delete a model snapshot # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to delete # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-snapshot.html # def delete_model_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_model_snapshot' } 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 56ea524b30..a253a26952 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. + # Delete an unreferenced trained model # # @option arguments [String] :model_id The ID of the trained model to delete # @option arguments [Time] :timeout Controls the amount of time to wait for the model to be deleted. # @option arguments [Boolean] :force True if the model should be forcefully deleted # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-trained-models.html # def delete_trained_model(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model' } 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 cc56b05856..8fa15fad72 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes a model alias that refers to the trained model + # Delete a trained model alias # # @option arguments [String] :model_alias The trained model alias to delete # @option arguments [String] :model_id The trained model where the model alias is assigned # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-trained-models-aliases.html # def delete_trained_model_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb index dc40e34a56..da4a38333b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Estimates the model memory + # Estimate job model memory usage # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The analysis config, plus cardinality estimates for fields it references (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-estimate-model-memory.html # def estimate_model_memory(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.estimate_model_memory' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb index 957f203433..1a5e11c387 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Evaluates the data frame analytics for an annotated index. + # Evaluate data frame analytics # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The evaluation definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/evaluate-dfanalytics.html # def evaluate_data_frame(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.evaluate_data_frame' } 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 8aef4b83b4..9cc8c88019 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Explains a data frame analytics config. + # Explain data frame analytics config # # @option arguments [String] :id The ID of the data frame analytics to explain # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics config to explain # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/explain-dfanalytics.html # def explain_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.explain_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb index 48b8334e30..3984045e43 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Forces any buffered data to be processed by the job. + # Force buffered data to be processed # # @option arguments [String] :job_id The name of the job to flush # @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period @@ -33,7 +33,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Flush parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-flush-job.html # def flush_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.flush_job' } 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 fefe7dbdb5..4c61670981 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Predicts the future behavior of a time series by using its historical behavior. + # Predict future behavior of a time series # # @option arguments [String] :job_id The ID of the job to forecast for # @option arguments [Time] :duration The duration of the forecast @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Query parameters can be specified in the body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-forecast.html # def forecast(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.forecast' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb index a68322b96a..c1535ff9e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more buckets. + # Get anomaly detection job results for buckets # # @option arguments [String] :job_id ID of the job to get bucket results from # @option arguments [String] :timestamp The timestamp of the desired single bucket result @@ -38,7 +38,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Bucket selection details if not provided in URI # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-bucket.html # def get_buckets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_buckets' } 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 d207e8872b..a92baad35b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves information about the scheduled events in calendars. + # Get info about events in calendars # # @option arguments [String] :calendar_id The ID of the calendar containing the events # @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all' @@ -32,7 +32,7 @@ module Actions # @option arguments [Integer] :size Specifies a max number of events to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-calendar-event.html # def get_calendar_events(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendar_events' } 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 b068075dbe..5af3cdfd04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for calendars. + # Get calendar configuration info # # @option arguments [String] :calendar_id The ID of the calendar to fetch # @option arguments [Integer] :from skips a number of calendars @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The from and size parameters optionally sent in the body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-calendar.html # def get_calendars(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendars' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb index 4bac8ea0e6..c6c047abf6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more categories. + # Get anomaly detection job results for categories # # @option arguments [String] :job_id The name of the job # @option arguments [Long] :category_id The identifier of the category definition of interest @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Category selection details if not provided in URI # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-category.html # def get_categories(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_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 a6a097d654..ef5ade3a69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for data frame analytics jobs. + # Get data frame analytics job configuration info # # @option arguments [String] :id The ID of the data frame analytics to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on data frame analytics PUT # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-dfanalytics.html # def get_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_data_frame_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 5a12263db7..996cee8c8f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for data frame analytics jobs. + # Get data frame analytics job stats # # @option arguments [String] :id The ID of the data frame analytics stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :verbose whether the stats response should be verbose # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-dfanalytics-stats.html # def get_data_frame_analytics_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_data_frame_analytics_stats' } 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 9a527cf537..210cc59235 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for datafeeds. + # Get datafeed stats # # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-datafeed-stats.html # def get_datafeed_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_datafeed_stats' } 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 f7c0d75e1a..df8e357671 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for datafeeds. + # Get datafeeds configuration info # # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on datafeed PUT # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-datafeed.html # def get_datafeeds(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_datafeeds' } 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 740d6087d1..3128814fef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves filters. + # Get filters # # @option arguments [String] :filter_id The ID of the filter to fetch # @option arguments [Integer] :from skips a number of filters # @option arguments [Integer] :size specifies a max number of filters to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-filter.html # def get_filters(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_filters' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb index c26cfe0ee3..f029b90134 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more influencers. + # Get anomaly detection job results for influencers # # @option arguments [String] :job_id Identifier for the anomaly detection job # @option arguments [Boolean] :exclude_interim Exclude interim results @@ -36,7 +36,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Influencer selection criteria # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-influencer.html # def get_influencers(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_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 a775aa6822..6ed150cad4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for anomaly detection jobs. + # Get anomaly detection job stats # # @option arguments [String] :job_id The ID of the jobs stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-job-stats.html # def get_job_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_job_stats' } 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 ed56801065..3c531a1c77 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for anomaly detection jobs. + # Get anomaly detection jobs configuration info # # @option arguments [String] :job_id The ID of the jobs to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on job PUT # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-job.html # def get_jobs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_jobs' } 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 001adaa2d5..8bab10d9e9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Returns information on how ML is using memory. + # Get machine learning memory usage info # # @option arguments [String] :node_id Specifies the node or nodes to retrieve stats for. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-ml-memory.html # def get_memory_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_memory_stats' } 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 561bd95bad..d5793af9b7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Gets stats for anomaly detection job model snapshot upgrades that are in progress. + # Get anomaly detection job model snapshot upgrade usage info # # @option arguments [String] :job_id The ID of the job. May be a wildcard, comma separated list or `_all`. # @option arguments [String] :snapshot_id The ID of the snapshot. May be a wildcard, comma separated list or `_all`. # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-job-model-snapshot-upgrade-stats.html # def get_model_snapshot_upgrade_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_model_snapshot_upgrade_stats' } 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 df56a11e88..7239661dee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves information about model snapshots. + # Get model snapshots info # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to fetch @@ -35,7 +35,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Model snapshot selection criteria # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-snapshot.html # def get_model_snapshots(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_model_snapshots' } 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 fa40a14238..9246810496 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. + # Get overall bucket results # # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results # @option arguments [Integer] :top_n The number of top job bucket scores to be used in the overall_score calculation @@ -35,7 +35,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Overall bucket selection details if not provided in URI # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html # def get_overall_buckets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_overall_buckets' } 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 66b4f6b7df..660b12ffb4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly records for an anomaly detection job. + # Get anomaly records for an anomaly detection job # # @option arguments [String] :job_id The ID of the job # @option arguments [Boolean] :exclude_interim Exclude interim results @@ -36,7 +36,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Record selection criteria # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-record.html # def get_records(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_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 09b7813943..c3d79b2327 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for a trained inference model. + # Get trained model configuration info # # @option arguments [String] :model_id The ID of the trained models to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on model PUT # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-trained-models.html # def get_trained_models(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_trained_models' } 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 0d56ddb20a..75161d2787 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for trained inference models. + # Get trained models usage info # # @option arguments [String] :model_id The ID of the trained models stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) @@ -30,7 +30,7 @@ module Actions # @option arguments [Integer] :size specifies a max number of trained models to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-trained-models-stats.html # def get_trained_models_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_trained_models_stats' } 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 59dbc17156..e6db0ebd02 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Evaluate a trained model. + # Evaluate a trained model # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. @@ -34,7 +34,7 @@ module Actions # Deprecated since version 8.3.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-trained-model.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-trained-model.html # def infer_trained_model(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.infer_trained_model' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb index c1f3d46670..1b965d70a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module MachineLearning module Actions - # Returns defaults and limits used by machine learning. + # Get machine learning information # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-ml-info.html # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.info' } 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 69ab6ad44e..b436235a04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Opens one or more anomaly detection jobs. + # Open anomaly detection jobs # # @option arguments [String] :job_id The ID of the job to open # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Query parameters can be specified in the body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-open-job.html # def open_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.open_job' } 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 c80bc49eab..1a1f63e1ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Posts scheduled events in a calendar. + # Add scheduled events to the calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body A list of events (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-post-calendar-event.html # def post_calendar_events(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.post_calendar_events' } 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 f19f58530b..bf4675af9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Sends data to an anomaly detection job for analysis. + # Send data to an anomaly detection job for analysis # # @option arguments [String] :job_id The name of the job receiving the data # @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data to process (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-post-data.html # def post_data(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.post_data' } 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 33e7ca9675..c458251b30 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Previews that will be analyzed given a data frame analytics config. + # Preview features used by data frame analytics # # @option arguments [String] :id The ID of the data frame analytics to preview # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics config to preview # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/preview-dfanalytics.html # def preview_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.preview_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb index 78f421329b..2e8cbbd18c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Previews a datafeed. + # Preview a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to preview # @option arguments [String] :start The start time from where the datafeed preview should begin @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The datafeed config and job config with which to execute the preview # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-preview-datafeed.html # def preview_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.preview_datafeed' } 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 6bac27c8cc..bcb7281274 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a calendar. + # Create a calendar # # @option arguments [String] :calendar_id The ID of the calendar to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The calendar details # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-calendar.html # def put_calendar(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_calendar' } 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 5c7b779e81..9047d4dcf8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Adds an anomaly detection job to a calendar. + # Add anomaly detection job to calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :job_id The ID of the job to add to the calendar # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-calendar-job.html # def put_calendar_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_calendar_job' } 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 737b51a739..d03b0ea3d0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a data frame analytics job. + # Create a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics configuration (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-dfanalytics.html # def put_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_data_frame_analytics' } 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 55ac679569..c6e8eed628 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a datafeed. + # Create a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The datafeed config (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-datafeed.html # def put_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_datafeed' } 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 b08ad3dc1c..6dd6e4a832 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a filter. + # Create a filter # # @option arguments [String] :filter_id The ID of the filter to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter details (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-filter.html # def put_filter(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_filter' } 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 d5cebda595..e99e57f2f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates an anomaly detection job. + # Create an anomaly detection job # # @option arguments [String] :job_id The ID of the job to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false). Only set if datafeed_config is provided. @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-job.html # def put_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_job' } 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 5107273c56..379041679e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates an inference trained model. + # Create a trained model # # @option arguments [String] :model_id The ID of the trained models to store # @option arguments [Boolean] :defer_definition_decompression If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The trained model configuration (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-models.html # def put_trained_model(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model' } 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 9da28749f1..43a177eca7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates a new model alias (or reassigns an existing one) to refer to the trained model + # Create or update a trained model alias # # @option arguments [String] :model_alias The trained model alias to update # @option arguments [String] :model_id The trained model where the model alias should be assigned # @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. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-models-aliases.html # def put_trained_model_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_alias' } 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 5fb6155e59..d3e833948f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates part of a trained model definition + # Create part of a trained model definition # # @option arguments [String] :model_id The ID of the trained model for this definition part # @option arguments [Integer] :part The part number # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The trained model definition part (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-model-definition-part.html # def put_trained_model_definition_part(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_definition_part' } 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 f080f5f763..81ef4032b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates a trained model vocabulary + # Create a trained model vocabulary # # @option arguments [String] :model_id The ID of the trained model for this vocabulary # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The trained model vocabulary (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-model-vocabulary.html # def put_trained_model_vocabulary(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_vocabulary' } 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 a5ce0e1b20..9381b47509 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Resets an existing anomaly detection job. + # Reset an anomaly detection job # # @option arguments [String] :job_id The ID of the job to reset # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-reset-job.html # def reset_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.reset_job' } 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 80f70b212a..884bcd5ca2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Reverts to a specific snapshot. + # Revert to a snapshot # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to revert to @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Reversion options # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-revert-snapshot.html # def revert_model_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.revert_model_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 08bba48120..77f0e9f0bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. + # Set upgrade_mode for ML indices # # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false. # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-set-upgrade-mode.html # def set_upgrade_mode(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.set_upgrade_mode' } 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 f54893de3d..c7679ed5c4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Starts a data frame analytics job. + # Start a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to start # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The start data frame analytics parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-dfanalytics.html # def start_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.start_data_frame_analytics' } 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 ec6b3957df..5ac64e54ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Starts one or more datafeeds. + # Start datafeeds # # @option arguments [String] :datafeed_id The ID of the datafeed to start # @option arguments [String] :start The start time from where the datafeed should begin @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The start datafeed parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-start-datafeed.html # def start_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.start_datafeed' } 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 9a63f004ab..82bf05ba54 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Start a trained model deployment. + # Start a trained model deployment # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [String] :cache_size A byte-size value for configuring the inference cache size. For example, 20mb. @@ -34,8 +34,9 @@ module Actions # @option arguments [Time] :timeout Controls the amount of time to wait for the model to deploy. # @option arguments [String] :wait_for The allocation status for which to wait (options: starting, started, fully_allocated) # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The settings for the trained model deployment # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trained-model-deployment.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-trained-model-deployment.html # def start_trained_model_deployment(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.start_trained_model_deployment' } @@ -50,7 +51,7 @@ def start_trained_model_deployment(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = arguments.delete(:body) _model_id = arguments.delete(:model_id) 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 142085941a..56e627752f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Stops one or more data frame analytics jobs. + # Stop data frame analytics jobs # # @option arguments [String] :id The ID of the data frame analytics to stop # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The stop data frame analytics parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stop-dfanalytics.html # def stop_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_data_frame_analytics' } 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 dd7e8f0ad3..416856a295 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb @@ -22,17 +22,16 @@ module Elasticsearch module API module MachineLearning module Actions - # Stops one or more datafeeds. + # Stop datafeeds # # @option arguments [String] :datafeed_id The ID of the datafeed to stop # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) - # @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* # @option arguments [Boolean] :force True if the datafeed should be forcefully stopped. # @option arguments [Time] :timeout Controls the time to wait until a datafeed has stopped. Default to 20 seconds # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The URL params optionally sent in the body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-stop-datafeed.html # def stop_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_datafeed' } 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 df59c9fb7a..c72734201b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Stop a trained model deployment. + # Stop a trained model deployment # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified) @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The stop deployment parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-trained-model-deployment.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stop-trained-model-deployment.html # def stop_trained_model_deployment(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_trained_model_deployment' } 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 fe5c713b46..27ed528f66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a data frame analytics job. + # Update a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics settings to update (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-data-frame-analytics # def update_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb index 34dc4dc9e3..a8e29e49ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a datafeed. + # Update a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to update # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The datafeed update settings (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-datafeed.html # def update_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_datafeed' } 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 a540151478..9765fcc9f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates the description of a filter, adds items, or removes items. + # Update a filter # # @option arguments [String] :filter_id The ID of the filter to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter update (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-filter.html # def update_filter(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_filter' } 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 6ed25d906e..e8b4c2b4e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of an anomaly detection job. + # Update an anomaly detection job # # @option arguments [String] :job_id The ID of the job to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job update settings (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-job.html # def update_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_job' } 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 06c73a0dcc..a3eb572bd7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a snapshot. + # Update a snapshot # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The model snapshot properties to update (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-snapshot.html # def update_model_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_model_snapshot' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb index 64c623c328..2dd9307dc5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of trained model deployment. + # Update a trained model deployment # # @option arguments [String] :model_id The unique identifier of the trained model. # @option arguments [Integer] :number_of_allocations Update the model deployment to this number of allocations. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The updated trained model deployment settings # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-trained-model-deployment # def update_trained_model_deployment(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_trained_model_deployment' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb index 7d21a2afd3..64913a4c8c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Upgrades a given job snapshot to the current major version. + # Upgrade a snapshot # # @option arguments [String] :job_id The ID of the job # @option arguments [String] :snapshot_id The ID of the snapshot @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion Should the request wait until the task is complete before responding to the caller. Default is false. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-upgrade-job-model-snapshot.html # def upgrade_job_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.upgrade_job_snapshot' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb index 66a4a8a394..fd904576da 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Validates an anomaly detection job. + # Validate an anomaly detection job # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job config (*Required*) # - # @see https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html + # @see https://www.elastic.co/guide/en/machine-learning/8.19/ml-jobs.html # def validate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.validate' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb index 77f97b9c46..96b73afbd9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Validates an anomaly detection detector. + # Validate an anomaly detection job # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The detector (*Required*) # - # @see https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8 # def validate_detector(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.validate_detector' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb index ada183568f..7b9d777b73 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to get multiple documents in one request. + # Get multiple documents # # @option arguments [String] :index The name of the index # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. @@ -36,7 +36,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-get.html # def mget(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'mget' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb index 561bfa4c0d..10d3304f9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Migration module Actions - # Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. + # Get deprecation information # # @option arguments [String] :index Index pattern # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/migration-api-deprecation.html # def deprecations(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.deprecations' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb index b5263b949f..ad535a83c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Migration module Actions - # Find out whether system features need to be upgraded or not + # Get feature migration information # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/feature-migration-api.html # def get_feature_upgrade_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.get_feature_upgrade_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb index 64f31d63d6..d6b7e316db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Migration module Actions - # Begin upgrades for system features + # Start the feature migration # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/feature-migration-api.html # def post_feature_upgrade(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.post_feature_upgrade' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb index fe2526af71..4e55791c44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Monitoring module Actions - # Used by the monitoring features to send monitoring data. + # Send monitoring data # # @option arguments [String] :type Default document type for items which don't provide one *Deprecated* # @option arguments [String] :system_id Identifier of the monitored system @@ -37,7 +37,7 @@ module Actions # Deprecated since version 7.0.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/monitor-elasticsearch-cluster.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8 # def bulk(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'monitoring.bulk' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index 4b326a03fc..78924a711d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -21,20 +21,26 @@ module Elasticsearch module API module Actions - # Allows to execute several search operations in one request. + # Run multiple searches # # @option arguments [List] :index A comma-separated list of index names to use as default # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response - # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + # @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 *Deprecated* + # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [List] :routing A comma-separated list of specific routing values + # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-multi-search.html # def msearch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'msearch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb index 9f8c741f39..063a986ead 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to execute several search template operations in one request. + # Run multiple templated searches # # @option arguments [List] :index A comma-separated list of index names to use as default # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/multi-search-template.html # def msearch_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'msearch_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb index 2621ff9d51..a91b7c6afb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns multiple termvectors in one request. + # Get multiple term vectors # # @option arguments [String] :index The index in which the document resides. # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body @@ -39,7 +39,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-termvectors.html # def mtermvectors(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'mtermvectors' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb index 9d26816ac4..9409b59df0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Removes the archived repositories metering information present in the cluster. + # Clear the archived repositories metering # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Long] :max_archive_version Specifies the maximum archive_version to be cleared from the archive. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-repositories-metering-archive-api.html # def clear_repositories_metering_archive(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.clear_repositories_metering_archive' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb index 9afe42fab4..12ebbd912c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns cluster repositories metering information. + # Get cluster repositories metering # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-repositories-metering-api.html # def get_repositories_metering_info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.get_repositories_metering_info' } 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 20465247db..397dcabaf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns information about hot threads on each node in the cluster. + # Get the hot threads for nodes # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [Time] :interval The interval for the second sampling of threads @@ -34,7 +34,7 @@ module Actions # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-hot-threads.html # def hot_threads(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.hot_threads' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb index 0fb3986309..f1ff1930e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns information about nodes in the cluster. + # Get node information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none) @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-info.html # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.info' } 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 8c7ed792db..681e64c43f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Nodes module Actions - # Reloads secure settings. + # Reload the keystore on nodes in the cluster # # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html#reloadable-secure-settings + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-reload-secure-settings.html # def reload_secure_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.reload_secure_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb index 318d8c217c..410ad99353 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns statistical information about nodes in the cluster. + # Get node statistics # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure) @@ -38,7 +38,7 @@ module Actions # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-stats.html # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb index 9d5150ab6c..02c40d808d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Nodes module Actions - # Returns low-level information about REST actions usage on nodes. + # Get feature usage information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions) # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-usage.html # def usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.usage' } 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 3324db458f..7e86a0b8a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Open a point in time that can be used in subsequent searches + # Open a point in time # # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) @@ -29,10 +29,12 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @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] :keep_alive Specific the time to live for the point in time (*Required*) + # @option arguments [Boolean] :allow_partial_search_results Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false) + # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An index_filter specified with the Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html # def open_point_in_time(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'open_point_in_time' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb index 7f8dd0bbf8..a9bc325c35 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns whether the cluster is running. + # Ping the cluster # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster.html # def ping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ping' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb index a809de4a9e..3053d0e846 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Profiling module Actions - # Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. + # Extracts a UI-optimized structure to render flamegraphs from Universal Profiling # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter conditions for the flamegraph (*Required*) # - # @see https://www.elastic.co/guide/en/observability/current/universal-profiling.html + # @see https://www.elastic.co/guide/en/observability/8.19/universal-profiling.html # def flamegraph(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'profiling.flamegraph' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb index 5d2e78c2e3..59ab3fc9ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Profiling module Actions - # Extracts raw stacktrace information from Universal Profiling. + # Extracts raw stacktrace information from Universal Profiling # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter conditions for stacktraces (*Required*) # - # @see https://www.elastic.co/guide/en/observability/current/universal-profiling.html + # @see https://www.elastic.co/guide/en/observability/8.19/universal-profiling.html # def stacktraces(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'profiling.stacktraces' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb index 78c74a494a..028a19da66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Profiling module Actions - # Returns basic information about the status of Universal Profiling. + # Returns basic information about the status of Universal Profiling # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :wait_for_resources_created Whether to return immediately or wait until resources have been created # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/observability/current/universal-profiling.html + # @see https://www.elastic.co/guide/en/observability/8.19/universal-profiling.html # def status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'profiling.status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb index 856f84542b..88886c5c48 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Profiling module Actions - # Extracts a list of topN functions from Universal Profiling. + # Extracts a list of topN functions from Universal Profiling # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter conditions for stacktraces (*Required*) # - # @see https://www.elastic.co/guide/en/observability/current/universal-profiling.html + # @see https://www.elastic.co/guide/en/observability/8.19/universal-profiling.html # def topn_functions(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'profiling.topn_functions' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb index b720d74044..f23ac09c2d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Creates or updates a script. + # Create or update a script or search template # # @option arguments [String] :id Script ID # @option arguments [String] :context Script context @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The document (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-stored-script-api.html # def put_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'put_script' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb index a7f69d8916..0d000d272d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module QueryRules module Actions - # Deletes an individual query rule within a ruleset. + # Delete a query rule # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset this rule exists in # @option arguments [String] :rule_id The unique identifier of the rule to delete. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-rule.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-query-rule.html # def delete_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.delete_rule' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb index 057962e12a..857150a02d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module QueryRules module Actions - # Deletes a query ruleset. + # Delete a query ruleset # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-ruleset.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-query-ruleset.html # def delete_ruleset(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.delete_ruleset' } @@ -48,11 +48,19 @@ def delete_ruleset(arguments = {}) method = Elasticsearch::API::HTTP_DELETE path = "_query_rules/#{Utils.__listify(_ruleset_id)}" - params = {} + params = Utils.process_params(arguments) - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) + if Array(arguments[:ignore]).include?(404) + Utils.__rescue_from_not_found do + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + else + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end end end end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb index 579d2a9627..cef54b4557 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module QueryRules module Actions - # Returns the details about an individual query rule within a ruleset. + # Get a query rule # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset the rule exists within # @option arguments [String] :rule_id The unique identifier of the rule to be retrieved. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-rule.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-query-rule.html # def get_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.get_rule' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb index 3eb2931d90..d2e08f6004 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module QueryRules module Actions - # Returns the details about a query ruleset. + # Get a query ruleset # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-ruleset.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-query-ruleset.html # def get_ruleset(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.get_ruleset' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb index 46cb469e2a..cab2036256 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module QueryRules module Actions - # Lists query rulesets. + # Get all query rulesets # # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size specifies a max number of results to get (default: 100) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-query-rulesets.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-query-rulesets.html # def list_rulesets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.list_rulesets' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb index 659f785d6c..d23c5cde36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module QueryRules module Actions - # Creates or updates a query rule within a ruleset. + # Create or update a query rule # # @option arguments [String] :ruleset_id The unique identifier of the ruleset this rule should be added to. The ruleset will be created if it does not exist. # @option arguments [String] :rule_id The unique identifier of the rule to be created or updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The query rule configuration, including the type of rule, the criteria to match the rule, and the action that should be taken if the rule matches. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-rule.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-query-rule.html # def put_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.put_rule' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb index ed042f3960..3d191690f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module QueryRules module Actions - # Creates or updates a query ruleset. + # Create or update a query ruleset # # @option arguments [String] :ruleset_id The unique identifier of the ruleset to be created or updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The query ruleset configuration, including `rules` (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-ruleset.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-query-ruleset.html # def put_ruleset(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.put_ruleset' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb new file mode 100644 index 0000000000..43e2b6af70 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb @@ -0,0 +1,62 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module QueryRules + module Actions + # Test a query ruleset + # + # @option arguments [String] :ruleset_id The unique identifier of the ruleset to test. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The match criteria to test against the ruleset (*Required*) + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/test-query-ruleset.html + # + def test(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'query_rules.test' } + + defined_params = [:ruleset_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _ruleset_id = arguments.delete(:ruleset_id) + + method = Elasticsearch::API::HTTP_POST + path = "_query_rules/#{Utils.__listify(_ruleset_id)}/_test" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index f9477705e7..c7bf9a7da4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to evaluate the quality of ranked search results over a set of typical search queries + # Evaluate ranked search results # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-rank-eval.html # def rank_eval(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rank_eval' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index 1447568931..daa3836955 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -21,9 +21,7 @@ module Elasticsearch module API module Actions - # Allows to copy documents from one index to another, optionally filtering the source - # documents by a query, changing the destination index settings, or fetching the - # documents from a remote cluster. + # Reindex documents # # @option arguments [Boolean] :refresh Should the affected indexes be refreshed? # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable. @@ -33,10 +31,11 @@ module Actions # @option arguments [Time] :scroll Control how long to keep the search context alive # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents) + # @option arguments [Boolean] :require_alias When true, requires destination to be an alias. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html # def reindex(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'reindex' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb index e528d3b6ed..e728f8d5c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Reindex operation. + # Throttle a reindex operation # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html # def reindex_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'reindex_rethrottle' } 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 90de6aaea6..ea5ab53e44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Allows to use the Mustache language to pre-render a search definition. + # Render a search template # # @option arguments [String] :id The id of the stored search template # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition template and its params # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/render-search-template-api.html # def render_search_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'render_search_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb index fe87cfa556..566145925d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Deletes an existing rollup job. + # Delete a rollup job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :id The ID of the job to delete # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-delete-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-delete-job.html # def delete_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.delete_job' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb index 4344386526..9f3eff2691 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Retrieves the configuration, stats, and status of rollup jobs. + # Get rollup job information # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :id The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-get-job.html # def get_jobs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.get_jobs' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb index 93ac86cec1..ccf2dfaba1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + # Get the rollup job capabilities # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :id The ID of the index to check rollup capabilities on, or left blank for all jobs # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-caps.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-get-rollup-caps.html # def get_rollup_caps(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.get_rollup_caps' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb index d530edc59f..62528ac2df 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). + # Get the rollup index capabilities # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :index The rollup index or index pattern to obtain rollup capabilities from. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-index-caps.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-get-rollup-index-caps.html # def get_rollup_index_caps(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.get_rollup_index_caps' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb index 1286e65c2b..5a61278db9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Creates a rollup job. + # Create a rollup job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job configuration (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-put-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-put-job.html # def put_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.put_job' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb index 597524c347..cc09c06856 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Enables searching rolled-up data using the standard query DSL. + # Search rolled-up data # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -34,7 +34,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search request body (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-search.html # def rollup_search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.rollup_search' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb index d1108d1ba3..e94cbc4d5a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Starts an existing, stopped rollup job. + # Start rollup jobs # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :id The ID of the job to start # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-start-job.html # def start_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.start_job' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb index f33070a4db..b1f7d5a7c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Stops an existing, started rollup job. + # Stop rollup jobs # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :timeout Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rollup-stop-job.html # def stop_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rollup.stop_job' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb index e9cc67da66..cb0b9a852e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows an arbitrary script to be executed and a result to be returned + # Run a script # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The script to execute # - # @see https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/painless/8.19/painless-execute-api.html # def scripts_painless_execute(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'scripts_painless_execute' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb index 2885c09a83..37caf871aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to retrieve a large numbers of results from a single search request. + # Run a scrolling search # # @option arguments [String] :scroll_id The scroll ID *Deprecated* # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search @@ -34,7 +34,7 @@ module Actions # Deprecated since version 7.0.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/scroll-api.html # def scroll(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'scroll' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index af314d82db..eaa1350f7d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns results matching a query. + # Run a search # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :analyzer The analyzer to use for the query string @@ -65,14 +65,14 @@ module Actions # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests - # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response # @option arguments [String] :min_compatible_shard_node The minimum compatible version that all shards involved in search should have for this request to be successful # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition using the Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-search.html # def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb index 165e1093dd..8d1fcd206a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module SearchApplication module Actions - # Deletes a search application. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Delete a search application + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-search-application.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-search-application.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb index 38ab030e26..da6eb33dc5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Delete a behavioral analytics collection. + # Delete a behavioral analytics collection # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :name The name of the analytics collection to be deleted # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-analytics-collection.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-analytics-collection.html # def delete_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete_behavioral_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb index a860983d7f..2207c84820 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb @@ -22,16 +22,16 @@ module Elasticsearch module API module SearchApplication module Actions - # Returns the details about a search application. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get search application details + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-search-application.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-search-application.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb index 03162964b8..a82c857bac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Returns the existing behavioral analytics collections. + # Get behavioral analytics collections # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [List] :name A comma-separated list of analytics collections to limit the returned information # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-analytics-collection.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-analytics-collection.html # def get_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.get_behavioral_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb index e16653f8d0..91d3e4bee6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb @@ -22,18 +22,18 @@ module Elasticsearch module API module SearchApplication module Actions - # Returns the existing search applications. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get search applications + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :q Query in the Lucene query string syntax # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size specifies a max number of results to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-search-applications.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-analytics-collection.html # def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.list' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb index 73ddcf543e..6899ee4f44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Creates a behavioral analytics event for existing collection. + # Create a behavioral analytics collection event # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -34,7 +34,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The event definition (*Required*) # - # @see http://todo.com/tbd + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-analytics-collection-event.html # def post_behavioral_analytics_event(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.post_behavioral_analytics_event' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb index 4b71715586..589dfc7b44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb @@ -22,18 +22,18 @@ module Elasticsearch module API module SearchApplication module Actions - # Creates or updates a search application. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create or update a search application + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application to be created or updated # @option arguments [Boolean] :create If true, requires that a search application with the specified resource_id does not already exist. (default: false) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search application configuration, including `indices` (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-search-application.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-search-application.html # def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.put' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb index b04054239f..2bee403078 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Creates a behavioral analytics collection. + # Create a behavioral analytics collection # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [String] :name The name of the analytics collection to be created or updated # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-analytics-collection.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-analytics-collection.html # def put_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.put_behavioral_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb index b6d21c350a..73583f4f7b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Renders a query for given search application search parameters + # Render a search application query # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Search parameters, which will override any default search parameters defined in the search application template # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-render-query.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-application-render-query.html # def render_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.render_query' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb index f3a7797355..eda911efbd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb @@ -22,18 +22,18 @@ module Elasticsearch module API module SearchApplication module Actions - # Perform a search against a search application - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Run a search application search + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application to be searched # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Search parameters, including template parameters that override defaults # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-application-search.html # def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.search' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb index 80bde3ce4f..15d859123e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb @@ -21,11 +21,7 @@ module Elasticsearch module API module Actions - # Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Search a vector tile # # @option arguments [List] :index Comma-separated list of data streams, indices, or aliases to search # @option arguments [String] :field Field containing geospatial data to return @@ -36,13 +32,14 @@ module Actions # @option arguments [Integer] :extent Size, in pixels, of a side of the vector tile. # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. Accepts 0-8. # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. (options: grid, point, centroid) + # @option arguments [String] :grid_agg Aggregation used to create a grid for `field`. (options: geotile, geohex) # @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000. # @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number. # @option arguments [Boolean] :with_labels If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Search request body. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-vector-tile-api.html # def search_mvt(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_mvt' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb index 70189da643..51d00d3112 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about the indices and shards that a search request would be executed against. + # Get the search shards # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-shards.html # def search_shards(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_shards' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index 5b67dfb582..c34c0d9f8e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to use the Mustache language to pre-render a search definition. + # Run a search with a search template # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -40,7 +40,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition template and its params (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-template-api.html # def search_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb index 89b16a6c14..12dd2ebd42 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchableSnapshots module Actions - # Retrieve node-level cache statistics about searchable snapshots. + # Get cache statistics # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-cache-stats.html # def cache_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.cache_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb index a7d0b6a246..ede1b5c096 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb @@ -28,13 +28,13 @@ module Actions # to fix any issues, but experimental features are not subject to the # support SLA of official GA features. # - # @option arguments [List] :index A comma-separated list of index names + # @option arguments [List] :index Clear the cache # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-clear-cache.html # def clear_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.clear_cache' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb index e8238c98b7..5273da36b4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchableSnapshots module Actions - # Mount a snapshot as a searchable index. + # Mount a snapshot # # @option arguments [String] :repository The name of the repository containing the snapshot of the index to mount # @option arguments [String] :snapshot The name of the snapshot of the index to mount @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The restore configuration for mounting the snapshot as searchable (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-mount-snapshot.html # def mount(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.mount' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb index eafb705ad0..627c902ffc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module SearchableSnapshots module Actions - # Retrieve shard-level statistics about searchable snapshots. + # Get searchable snapshot statistics # # @option arguments [List] :index A comma-separated list of index names # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-stats.html # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb index 776e2a88b7..4cc6a1e155 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Creates or updates the user profile on behalf of another user. + # Activate a user profile # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The grant type and user's credential (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-activate-user-profile.html # def activate_user_profile(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.activate_user_profile' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb index 03f02c57ea..62cc281bf4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Security module Actions - # Enables authentication as a user and retrieve information about the authenticated user. + # Authenticate a user # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-authenticate.html # def authenticate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.authenticate' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb index ae3d6bbfd1..b6928b010d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Bulk delete roles in the native realm. + # Bulk delete roles # # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The roles to delete (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-bulk-delete-role.html # def bulk_delete_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_delete_role' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb index 5ec4578391..efac4848b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Bulk adds and updates roles in the native realm. + # Bulk create or update roles # # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The roles to add (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-bulk-put-role.html # def bulk_put_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_put_role' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb index bf311c01f4..240f84b039 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Updates the attributes of multiple existing API keys. + # Bulk update API keys # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The API key request to update the attributes of multiple API keys. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-bulk-update-api-keys.html # def bulk_update_api_keys(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_update_api_keys' } 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 186861cdb7..47fbfdef89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Security module Actions - # Changes the passwords of users in the native realm and built-in users. + # Change passwords # # @option arguments [String] :username The username of the user to change the password for # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body the new password for the user (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-change-password.html # def change_password(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.change_password' } 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 8eb36221f1..33d419f71a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Clear a subset or all entries from the API key cache. + # Clear the API key cache # # @option arguments [List] :ids A comma-separated list of IDs of API keys to clear from the cache # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-clear-api-key-cache.html # def clear_api_key_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_api_key_cache' } 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 2b6ff2d79e..f795c20ad3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Evicts application privileges from the native application privileges cache. + # Clear the privileges cache # # @option arguments [List] :application A comma-separated list of application names # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-clear-privilege-cache.html # def clear_cached_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_privileges' } 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 9f427c62e3..4d4dc06e98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Evicts users from the user cache. Can completely clear the cache or evict specific users. + # Clear the user cache # # @option arguments [List] :realms Comma-separated list of realms to clear # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-clear-cache.html # def clear_cached_realms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_realms' } 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 8e253de2d5..8b07edb1eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Evicts roles from the native role cache. + # Clear the roles cache # # @option arguments [List] :name Role name # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-clear-role-cache.html # def clear_cached_roles(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_roles' } 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 e2d0d96d0b..a5aadec0a6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Security module Actions - # Evicts tokens from the service account token caches. + # Clear service account token caches # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [List] :name A comma-separated list of service token names # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-clear-service-token-caches.html # def clear_cached_service_tokens(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_service_tokens' } 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 eb05c11c87..7d409f7428 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Creates an API key for access without requiring basic authentication. + # Create an API key # # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The api key request to create an API key (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-create-api-key.html # def create_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.create_api_key' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb index 4933f9fbb8..5cf0d66261 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Creates a cross-cluster API key for API key based remote cluster access. + # Create a cross-cluster API key # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The request to create a cross-cluster API key (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-create-cross-cluster-api-key.html # def create_cross_cluster_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.create_cross_cluster_api_key' } 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 9ebfacea38..78ca0dd203 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates a service account token for access without requiring basic authentication. + # Create a service account token # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name @@ -30,7 +30,7 @@ module Actions # @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 # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-create-service-token.html # def create_service_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.create_service_token' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb new file mode 100644 index 0000000000..ddf9f8b0ce --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb @@ -0,0 +1,53 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Security + module Actions + # Delegate PKI authentication + # + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body The X509Certificate chain. (*Required*) + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delegate-pki-authentication.html + # + def delegate_pki(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.delegate_pki' } + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + method = Elasticsearch::API::HTTP_POST + path = '_security/delegate_pki' + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb index fa4260b296..cfd16c6c48 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Security module Actions - # Removes application privileges. + # Delete application privileges # # @option arguments [String] :application Application name # @option arguments [String] :name Privilege name # @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 # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-privilege.html # def delete_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_privileges' } 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 81a755ea5a..7cd068f53d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Removes roles in the native realm. + # Delete roles # # @option arguments [String] :name Role name # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-role.html # def delete_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_role' } 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 57cc5f4258..c4f119e49c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Removes role mappings. + # Delete role mappings # # @option arguments [String] :name Role-mapping name # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-role-mapping.html # def delete_role_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_role_mapping' } 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 e1e956f288..550dfcc4b8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Deletes a service account token. + # Delete service account tokens # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name @@ -30,7 +30,7 @@ module Actions # @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 # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-service-token.html # def delete_service_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_service_token' } 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 6c60f97ffc..6725b4e697 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Deletes users from the native realm. + # Delete users # # @option arguments [String] :username username # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-user.html # def delete_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_user' } 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 cd15f71593..170b5946a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Disables users in the native realm. + # Disable users # # @option arguments [String] :username The username of the user to disable # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-disable-user.html # def disable_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.disable_user' } 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 890f6959c9..2312b47575 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Disables a user profile so it's not visible in user profile searches. + # Disable a user profile # # @option arguments [String] :uid Unique identifier for the user profile # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user-profile.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-disable-user-profile.html # def disable_user_profile(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.disable_user_profile' } 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 e6dadc479f..8d9f172d7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Enables users in the native realm. + # Enable users # # @option arguments [String] :username The username of the user to enable # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-enable-user.html # def enable_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.enable_user' } 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 c494854720..ff66f1a5f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Enables a user profile so it's visible in user profile searches. + # Enable a user profile # # @option arguments [String] :uid An unique identifier of the user profile # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user-profile.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-enable-user-profile.html # def enable_user_profile(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.enable_user_profile' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb index 9c16f925ef..10909fc4d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Security module Actions - # Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. + # Enroll Kibana # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-kibana-enrollment.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-kibana-enrollment.html # def enroll_kibana(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.enroll_kibana' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb index 2a9dc5c0af..df69fc5734 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Security module Actions - # Allows a new node to enroll to an existing cluster with security enabled. + # Enroll a node # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-node-enrollment.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-node-enrollment.html # def enroll_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.enroll_node' } 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 b023edb480..e5bb9d02f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for one or more API keys. + # Get API key information # # @option arguments [String] :id API key id of the API key to be retrieved # @option arguments [String] :name API key name of the API key to be retrieved @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :active_only flag to limit response to only active (not invalidated or expired) API keys # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-api-key.html # def get_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_api_key' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb index aac95e8a75..01db8a6211 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Security module Actions - # Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + # Get builtin privileges # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-builtin-privileges.html # def get_builtin_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_builtin_privileges' } 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 08b6a96c22..5883f0ab5b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Retrieves application privileges. + # Get application privileges # # @option arguments [String] :application Application name # @option arguments [String] :name Privilege name # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-privileges.html # def get_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_privileges' } 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 9b8f533987..a99796dd0c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Retrieves roles in the native realm. + # Get roles # # @option arguments [List] :name A comma-separated list of role names # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-role.html # def get_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_role' } 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 2c6a79f930..afb0cb8536 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Retrieves role mappings. + # Get role mappings # # @option arguments [List] :name A comma-separated list of role-mapping names # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-role-mapping.html # def get_role_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_role_mapping' } 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 4bf5a17cf6..07091d000c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Retrieves information about service accounts. + # Get service accounts # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-service-accounts.html # def get_service_accounts(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_service_accounts' } 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 b66a44c054..a7e356f6f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Retrieves information of all service credentials for a service account. + # Get service account credentials # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-service-credentials.html # def get_service_credentials(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_service_credentials' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb index ce1a6ba852..7887cc0f99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Retrieve settings for the security system indices + # Get security index settings # # @option arguments [Time] :master_timeout Timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-settings.html # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb index bbe77102bb..fdb623745e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Creates a bearer token for access without requiring basic authentication. + # Get a token # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The token request to get (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-token.html # def get_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_token' } 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 94efebad8b..aa4ff49d18 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Retrieves information about users in the native realm and built-in users. + # Get users # # @option arguments [List] :username A comma-separated list of usernames # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated to the user # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-user.html # def get_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_user' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb index 926460dc99..e02f0a15f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Security module Actions - # Retrieves security privileges for the logged in user. + # Get user privileges # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-user-privileges.html # def get_user_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_user_privileges' } 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 85033b4a4d..db4293aa13 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Retrieves user profiles for the given unique ID(s). + # Get a user profile # # @option arguments [List] :uid A comma-separated list of unique identifier for user profiles # @option arguments [List] :data A comma-separated list of keys for which the corresponding application data are retrieved. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-user-profile.html # def get_user_profile(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_user_profile' } 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 19567099a6..c50294cc0f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Creates an API key on behalf of another user. + # Grant an API key # # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The api key request to create an API key (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-grant-api-key.html # def grant_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.grant_api_key' } 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 db564b4390..850ee8e6ab 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Determines whether the specified user has a specified list of privileges. + # Check user privileges # # @option arguments [String] :user Username # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The privileges to test (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-has-privileges.html # def has_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.has_privileges' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb index f65160e35c..07c8be9a1b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Determines whether the users associated with the specified profile IDs have all the requested privileges. + # Check user profile privileges # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The privileges to check and the list of profile IDs (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-has-privileges-user-profile.html # def has_privileges_user_profile(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.has_privileges_user_profile' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb index 4bc0e103fa..0ca34667c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Invalidates one or more API keys. + # Invalidate API keys # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The api key request to invalidate API key(s) (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-invalidate-api-key.html # def invalidate_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.invalidate_api_key' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb index dcae33c44c..bdc84dae55 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Invalidates one or more access tokens or refresh tokens. + # Invalidate a token # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The token to invalidate (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-invalidate-token.html # def invalidate_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.invalidate_token' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb index e100fc59b2..21953160bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair + # Authenticate OpenID Connect # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The OpenID Connect response to authenticate (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-oidc-authenticate.html # def oidc_authenticate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_authenticate' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb index e39f9d4b34..a989d2d1bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API + # Logout of OpenID Connect # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Access token and refresh token to invalidate (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-oidc-logout.html # def oidc_logout(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_logout' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb index 2d9247ecd4..dfb1aaa223 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Creates an OAuth 2.0 authentication request as a URL string + # Prepare OpenID connect authentication # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The OpenID Connect authentication realm configuration (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-oidc-prepare-authentication.html # def oidc_prepare_authentication(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_prepare_authentication' } 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 0e4b52836e..4123a1a87a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Adds or updates application privileges. + # Create or update application privileges # # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The privilege(s) to add (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-privileges.html # def put_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_privileges' } 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 a0e102ee73..44465dca7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Security module Actions - # Adds and updates roles in the native realm. + # Create or update roles # # @option arguments [String] :name Role name # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The role to add (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-role.html # def put_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_role' } 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 4e238c2d0b..bbfd7f4295 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Security module Actions - # Creates and updates role mappings. + # Create or update role mappings # # @option arguments [String] :name Role-mapping name # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The role mapping to add (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-role-mapping.html # def put_role_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_role_mapping' } 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 453d00ef59..6a41ef6fbc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Security module Actions - # Adds and updates users in the native realm. These users are commonly referred to as native users. + # Create or update users # # @option arguments [String] :username The username of the User # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The user to add (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-user.html # def put_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_user' } 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 02cf165e18..93d5e571e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for API keys using a subset of query DSL + # Find API keys with a query # # @option arguments [Boolean] :with_limited_by flag to show the limited-by role descriptors of API Keys # @option arguments [Boolean] :with_profile_uid flag to also retrieve the API Key's owner profile uid, if it exists @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body From, size, query, sort and search_after # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-api-key.html # def query_api_keys(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.query_api_keys' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb index c5d84ec159..fdeb64cf14 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for Roles using a subset of query DSL + # Find roles with a query # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body From, size, query, sort and search_after # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-role.html # def query_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.query_role' } 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 a4df6bb7ee..3a1940ad05 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for Users using a subset of query DSL + # Find users with a query # # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated with the user # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body From, size, query, sort and search_after # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-user.html # def query_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.query_user' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb index 7d0486ca5c..935faf7b70 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair + # Authenticate SAML # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The SAML response to authenticate (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-authenticate.html # def saml_authenticate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_authenticate' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb index 7d0db5fec3..1e47abba74 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Verifies the logout response sent from the SAML IdP + # Logout of SAML completely # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The logout response to verify (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-complete-logout.html # def saml_complete_logout(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_complete_logout' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb index 28951664e4..867e1b1daf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Consumes a SAML LogoutRequest + # Invalidate SAML # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The LogoutRequest message (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-invalidate.html # def saml_invalidate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_invalidate' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb index 17bccc2ddd..ce6c7dc0ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Invalidates an access token and a refresh token that were generated via the SAML Authenticate API + # Logout of SAML # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The tokens to invalidate (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-logout.html # def saml_logout(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_logout' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb index 81bec3685d..30778e696d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Creates a SAML authentication request + # Prepare SAML authentication # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The realm for which to create the authentication request, identified by either its name or the ACS URL (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-prepare-authentication.html # def saml_prepare_authentication(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_prepare_authentication' } 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 cecd339eee..87327766eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Security module Actions - # Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider + # Create SAML service provider metadata # # @option arguments [String] :realm_name The name of the SAML realm to get the metadata for # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-sp-metadata.html # def saml_service_provider_metadata(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_service_provider_metadata' } 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 566b2c9d3a..768c253a3b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Get suggestions for user profiles that match specified search criteria. + # Suggest a user profile # # @option arguments [List] :data A comma-separated list of keys for which the corresponding application data are retrieved. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The suggestion definition for user profiles # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-suggest-user-profile.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-suggest-user-profile.html # def suggest_user_profiles(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.suggest_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 dad4b51305..7544512c0c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Updates attributes of an existing API key. + # Update an API key # # @option arguments [String] :id The ID of the API key to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The API key request to update attributes of an API key. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-api-key.html # def update_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.update_api_key' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb index 141a5cd3af..42e378ea9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Security module Actions - # Updates attributes of an existing cross-cluster API key. + # Update a cross-cluster API key # # @option arguments [String] :id The ID of the cross-cluster API key to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The request to update attributes of a cross-cluster API key. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-cross-cluster-api-key.html # def update_cross_cluster_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.update_cross_cluster_api_key' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb index bd86ffcbca..ab64c64a81 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Security module Actions - # Update settings for the security system index + # Update security index settings # # @option arguments [Time] :master_timeout Timeout for connection to master # @option arguments [Time] :timeout Timeout for acknowledgements from all nodes # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object with the new settings for each index, if any (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-settings.html # def update_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.update_settings' } 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 271f147120..4cd3a07a66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Update application specific data for the user profile of the given unique ID. + # Update user profile data # # @option arguments [String] :uid An unique identifier of the user profile # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The application data to update (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-user-profile-data.html # def update_user_profile_data(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.update_user_profile_data' } 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..93eefb2f0f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb @@ -22,12 +22,14 @@ module Elasticsearch module API module Shutdown module Actions - # Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Cancel node shutdown preparations # # @option arguments [String] :node_id The node id of node to be removed from the shutdown state + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-shutdown.html # def delete_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'shutdown.delete_node' } @@ -48,7 +50,7 @@ def delete_node(arguments = {}) method = Elasticsearch::API::HTTP_DELETE path = "_nodes/#{Utils.__listify(_node_id)}/shutdown" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb index a54d202492..bac8eb1b31 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Shutdown module Actions - # Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Get the shutdown status # # @option arguments [String] :node_id Which node for which to retrieve the shutdown status # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-shutdown.html # def get_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'shutdown.get_node' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb index a8f49a550a..816b3e6d89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb @@ -22,13 +22,15 @@ module Elasticsearch module API module Shutdown module Actions - # Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Prepare a node to be shut down # # @option arguments [String] :node_id The node id of node to be shut down + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The shutdown type definition to register (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-shutdown.html # def put_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'shutdown.put_node' } @@ -50,7 +52,7 @@ def put_node(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = "_nodes/#{Utils.__listify(_node_id)}/shutdown" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb index 19ee6beeed..64b095eb5c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Simulate module Actions - # Simulates running ingest with example documents. + # Simulate data ingestion # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -33,7 +33,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The simulate definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-ingest-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/simulate-ingest-api.html # def ingest(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'simulate.ingest' } 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 dfc7b63c8c..a90790bc7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Snapshot module Actions - # Removes stale data from repository. + # Clean up the snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clean-up-snapshot-repo-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clean-up-snapshot-repo-api.html # def cleanup_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.cleanup_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb index 4771ebf213..4e35e82853 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Clones indices from one snapshot into another snapshot in the same repository. + # Clone a snapshot # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot The name of the snapshot to clone from @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot clone definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clone-snapshot-api.html # def clone(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.clone' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb index 7b6e01d725..152a81e5de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Creates a snapshot in a repository. + # Create a snapshot # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot definition # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-snapshot-api.html # def create(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb index aa94f85ffe..40567ba775 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Creates a repository. + # Create or update a snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The repository definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-snapshot-repo-api.html # def create_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb index 3489aad395..0b9b09df71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Deletes one or more snapshots. + # Delete snapshots # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-snapshot-api.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb index c6168a3ff7..358056bf09 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Snapshot module Actions - # Deletes a repository. + # Delete snapshot repositories # # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-snapshot-repo-api.html # def delete_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb index fcb5af696b..77ccf316a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Returns information about a snapshot. + # Get snapshot information # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names @@ -41,7 +41,7 @@ module Actions # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-snapshot-api.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb index 83f3983f5d..d9e2b2f207 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Snapshot module Actions - # Returns information about a repository. + # Get snapshot repository information # # @option arguments [List] :repository A comma-separated list of repository names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-snapshot-repo-api.html # def get_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb index 575313a411..8054fb5326 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb @@ -22,11 +22,12 @@ module Elasticsearch module API module Snapshot module Actions - # Analyzes a repository for correctness and performance + # Analyze a snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100. # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10. + # @option arguments [Number] :register_operation_count The minimum number of linearizable register operations to perform in total. Defaults to 10. # @option arguments [Number] :read_node_count Number of nodes on which to read a blob after writing. Defaults to 10. # @option arguments [Number] :early_read_node_count Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2. # @option arguments [Number] :seed Seed for the random number generator used to create the test workload. Defaults to a random value. @@ -38,7 +39,7 @@ module Actions # @option arguments [Boolean] :rarely_abort_writes Whether to rarely abort writes before they complete. Defaults to 'true'. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/repo-analysis-api.html # def repository_analyze(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.repository_analyze' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb index 02e05a2114..0d7ba04e33 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Restores a snapshot. + # Restore a snapshot # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Details of what to restore # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/restore-snapshot-api.html # def restore(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.restore' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb index d6fa97d5ea..3dc6f3bb7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Returns information about the status of a snapshot. + # Get the snapshot status # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-snapshot-status-api.html # def status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb index 335d962d3c..acbcf56543 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Snapshot module Actions - # Verifies a repository. + # Verify a snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/verify-snapshot-repo-api.html # def verify_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.verify_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb index 5a9f45b135..b00558f909 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb @@ -22,12 +22,14 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Deletes an existing snapshot lifecycle policy. + # Delete a policy # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-delete-policy.html # def delete_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.delete_lifecycle' } @@ -48,7 +50,7 @@ def delete_lifecycle(arguments = {}) method = Elasticsearch::API::HTTP_DELETE path = "_slm/policy/#{Utils.__listify(_policy_id)}" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) 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 910f03a94c..f28fd6bfbf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb @@ -22,12 +22,14 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + # Run a policy # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-execute-lifecycle.html # def execute_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_lifecycle' } @@ -48,7 +50,7 @@ def execute_lifecycle(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = "_slm/policy/#{Utils.__listify(_policy_id)}/_execute" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb index e7ee4d4e3c..23f4c85d3c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb @@ -22,11 +22,13 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Deletes any snapshots that are expired according to the policy's retention rules. + # Run a retention policy # + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-execute-retention.html # def execute_retention(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_retention' } @@ -38,7 +40,7 @@ def execute_retention(arguments = {}) method = Elasticsearch::API::HTTP_POST path = '_slm/_execute_retention' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) 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 56a4c31795..b0e4156a65 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb @@ -22,12 +22,14 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + # Get policy information # # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-get-policy.html # def get_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.get_lifecycle' } @@ -50,7 +52,7 @@ def get_lifecycle(arguments = {}) else '_slm/policy' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb index 9f86cb46c5..e02f27d588 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb @@ -22,11 +22,13 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + # Get snapshot lifecycle management statistics # + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-get-stats.html # def get_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.get_stats' } @@ -38,7 +40,7 @@ def get_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = '_slm/stats' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb index c0fc5de920..48b174e952 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb @@ -22,11 +22,13 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Retrieves the status of snapshot lifecycle management (SLM). + # Get the snapshot lifecycle management status # + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-get-status.html # def get_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.get_status' } @@ -38,7 +40,7 @@ def get_status(arguments = {}) method = Elasticsearch::API::HTTP_GET path = '_slm/status' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) 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 0107fe34f6..5731ce3509 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb @@ -22,13 +22,15 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Creates or updates a snapshot lifecycle policy. + # Create or update a policy # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot lifecycle policy definition to register # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-put-policy.html # def put_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.put_lifecycle' } @@ -49,7 +51,7 @@ def put_lifecycle(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = "_slm/policy/#{Utils.__listify(_policy_id)}" - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb index 7e5a1d73bf..f134ae7c64 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Turns on snapshot lifecycle management (SLM). + # Start snapshot lifecycle management # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-start.html # def start(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.start' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb index d5dbab1d1e..7f219a8258 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Turns off snapshot lifecycle management (SLM). + # Stop snapshot lifecycle management # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-stop.html # def stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.stop' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb index c9ff2560fe..98ba23042d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module SQL module Actions - # Clears the SQL cursor + # Clear an SQL search cursor # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-sql-cursor-api.html # def clear_cursor(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.clear_cursor' } 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 06b0b77f9d..7e80224f46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module SQL module Actions - # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + # Delete an async SQL search # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-async-sql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-async-sql-search-api.html # def delete_async(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.delete_async' } 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 c1eb5685ea..1d9e222689 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SQL module Actions - # Returns the current status and available results for an async SQL search or stored synchronous SQL search + # Get async SQL search results # # @option arguments [String] :id The async search ID # @option arguments [String] :delimiter Separator for CSV results @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :wait_for_completion_timeout Duration to wait for complete results # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-async-sql-search-api.html # def get_async(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async' } 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 a217d9fdae..a14b485f25 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module SQL module Actions - # Returns the current status of an async SQL search or a stored synchronous SQL search + # Get the async SQL search status # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-status-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-async-sql-search-status-api.html # def get_async_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb index 7a187a5107..ae3216bcb2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module SQL module Actions - # Executes a SQL request + # Get SQL search results # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/sql-search-api.html # def query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.query' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb index 1f872caf67..145e6eb7d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module SQL module Actions - # Translates SQL into Elasticsearch queries + # Translate SQL into Elasticsearch queries # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/sql-translate-api.html # def translate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.translate' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb index 004f33c185..4bc964d830 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module SSL module Actions - # Retrieves information about the X.509 certificates used to encrypt communications in the cluster. + # Get SSL certificates # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-ssl.html # def certificates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ssl.certificates' } 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 9d91211e7a..b389c46254 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Synonyms module Actions - # Deletes a synonym set + # Delete a synonym set # # @option arguments [String] :id The id of the synonyms set to be deleted # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonyms-set.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-synonyms-set.html # def delete_synonym(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym' } 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 26183609b4..79882e81b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Synonyms module Actions - # Deletes a synonym rule in a synonym set + # Delete a synonym rule # # @option arguments [String] :set_id The id of the synonym set to be updated # @option arguments [String] :rule_id The id of the synonym rule to be deleted # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonym-rule.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-synonym-rule.html # def delete_synonym_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym_rule' } 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 c09fddeac4..2a5459e98c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Synonyms module Actions - # Retrieves a synonym set + # Get a synonym set # # @option arguments [String] :id The name of the synonyms set to be retrieved # @option arguments [Integer] :from Starting offset # @option arguments [Integer] :size specifies a max number of results to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonyms-set.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-synonyms-set.html # def get_synonym(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym' } 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 59769ec746..8155eba326 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Synonyms module Actions - # Retrieves a synonym rule from a synonym set + # Get a synonym rule # # @option arguments [String] :set_id The id of the synonym set to retrieve the synonym rule from # @option arguments [String] :rule_id The id of the synonym rule to retrieve # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonym-rule.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-synonym-rule.html # def get_synonym_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym_rule' } 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 3580303fb4..28fd344cb5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Synonyms module Actions - # Retrieves a summary of all defined synonym sets + # Get all synonym sets # # @option arguments [Integer] :from Starting offset # @option arguments [Integer] :size specifies a max number of results to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-synonyms-sets.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-synonyms-set.html # def get_synonyms_sets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonyms_sets' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb index 99a76d6515..160df4a84d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Synonyms module Actions - # Creates or updates a synonyms set + # Create or update a synonym set # # @option arguments [String] :id The id of the synonyms set to be created or updated # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Synonyms set rules (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonyms-set.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-synonyms-set.html # def put_synonym(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym' } 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 cc7804380e..86406efd16 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Synonyms module Actions - # Creates or updates a synonym rule in a synonym set + # Create or update a synonym rule # # @option arguments [String] :set_id The id of the synonym set to be updated with the synonym rule # @option arguments [String] :rule_id The id of the synonym rule to be updated or created # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Synonym rule (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonym-rule.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-synonym-rule.html # def put_synonym_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym_rule' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb index 9ce81d2afc..72703d28dd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Tasks module Actions - # Cancels a task, if it can be cancelled through an API. + # Cancel a task # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/tasks.html # def cancel(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'tasks.cancel' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb index 49f700537a..3ba88629e3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Tasks module Actions - # Returns information about a task. + # Get task information # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -33,7 +33,7 @@ module Actions # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/tasks.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'tasks.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb index 52c522cbea..ada230ddf0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Tasks module Actions - # Returns a list of tasks. + # Get all tasks # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -37,7 +37,7 @@ module Actions # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/tasks.html # def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'tasks.list' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb index 93cbc80f7e..e394afaae2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + # Get terms in an index # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body field name, string which is the prefix expected in matching terms, timeout and size for max number of results # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-terms-enum.html # def terms_enum(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'terms_enum' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb index 8b834d9ab6..e607a60612 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information and statistics about terms in the fields of a particular document. + # Get term vector information # # @option arguments [String] :index The index in which the document resides. # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied. @@ -39,7 +39,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-termvectors.html # def termvectors(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'termvectors' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb index 8464acff62..2d2dd90857 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a text field in an index. + # Find the structure of a text field # # @option arguments [String] :index The index containing the analyzed field (*Required*) # @option arguments [String] :field The field that should be analyzed (*Required*) @@ -40,7 +40,7 @@ module Actions # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-field-structure.html # def find_field_structure(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_field_structure' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb index fcd7456472..927bf13e08 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch. + # Find the structure of text messages # # @option arguments [Time] :timeout Timeout after which the analysis will be aborted # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text) @@ -38,7 +38,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body JSON object with one field [messages], containing an array of messages to be analyzed (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-message-structure.html # def find_message_structure(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_message_structure' } 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 099d91ebc5..b5157099c9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. + # Find the structure of a text file # # @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis # @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages. @@ -42,7 +42,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-structure.html # def find_structure(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_structure' } 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 49fad35ecd..3bfde7707b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module TextStructure module Actions - # Tests a Grok pattern on some text. + # Test a Grok pattern # # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The Grok pattern and text. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/test-grok-pattern.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/test-grok-pattern.html # def test_grok_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.test_grok_pattern' } 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 9bf20808c6..db48decef3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Deletes an existing transform. + # Delete a transform # # @option arguments [String] :transform_id The id of the transform to delete # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted. @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :timeout Controls the time to wait for the transform deletion # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-transform.html # def delete_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.delete_transform' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb index 69d76d7474..dd184906d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Transform module Actions - # Retrieves transform usage information for transform nodes. + # Retrieves transform usage information for transform nodes # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-transform-node-stats.html # def get_node_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.get_node_stats' } 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 5065124f1e..8a4d685db7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Retrieves configuration information for transforms. + # Get transforms # # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on transform PUT # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-transform.html # def get_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform' } 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 abdf7014d8..494084dfd5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Retrieves usage information for transforms. + # Get transform stats # # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms # @option arguments [Number] :from skips a number of transform stats, defaults to 0 @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-transform-stats.html # def get_transform_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform_stats' } 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 8ab4f59a7c..e0f05db2da 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Transform module Actions - # Previews a transform. + # Preview a transform # # @option arguments [String] :transform_id The id of the transform to preview. # @option arguments [Time] :timeout Controls the time to wait for the preview # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The definition for the transform to preview # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/preview-transform.html # def preview_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.preview_transform' } 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 222912fe22..0b880fc389 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Instantiates a transform. + # Create a transform # # @option arguments [String] :transform_id The id of the new transform. # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The transform definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-transform.html # def put_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.put_transform' } 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 dab3b5e94e..4e501327ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Transform module Actions - # Resets an existing transform. + # Reset a transform # # @option arguments [String] :transform_id The id of the transform to reset # @option arguments [Boolean] :force When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset. # @option arguments [Time] :timeout Controls the time to wait for the transform to reset # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/reset-transform.html # def reset_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.reset_transform' } 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 74716246b6..d996ce1e03 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Transform module Actions - # Schedules now a transform. + # Schedule a transform to start now # # @option arguments [String] :transform_id The id of the transform. (*Required*) # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/schedule-now-transform.html # def schedule_now_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.schedule_now_transform' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb new file mode 100644 index 0000000000..4d5ff41993 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb @@ -0,0 +1,52 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Transform + module Actions + # Set upgrade_mode for transform indices + # + # @option arguments [Boolean] :enabled Whether to enable upgrade_mode Transform setting or not. Defaults to false. + # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode + # + def set_upgrade_mode(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' } + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + method = Elasticsearch::API::HTTP_POST + path = '_transform/set_upgrade_mode' + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb index 4f18b6a0b7..dff3844d1a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Transform module Actions - # Starts one or more transforms. + # Start a transform # # @option arguments [String] :transform_id The id of the transform to start # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time # @option arguments [Time] :timeout Controls the time to wait for the transform to start # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-transform.html # def start_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.start_transform' } 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 00a4c41355..32016ea903 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Stops one or more transforms. + # Stop transforms # # @option arguments [String] :transform_id The id of the transform to stop # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :wait_for_checkpoint Whether to wait for the transform to reach a checkpoint before stopping. Default to false # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stop-transform.html # def stop_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.stop_transform' } 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 44e04a7ee1..22c1d94b2e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Updates certain properties of a transform. + # Update a transform # # @option arguments [String] :transform_id The id of the transform. (*Required*) # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The update transform definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-update-transform # def update_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.update_transform' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb index b2d1a84cd6..a1fd8a18c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Transform module Actions - # Upgrades all transforms. + # Upgrade all transforms # # @option arguments [Boolean] :dry_run Whether to only check for updates but don't execute # @option arguments [Time] :timeout Controls the time to wait for the upgrade # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms # def upgrade_transforms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.upgrade_transforms' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index 8039f1a25b..293d406c36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Updates a document with a script or partial document. + # Update a document # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index @@ -37,10 +37,11 @@ module Actions # @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 # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update.html # def update(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'update' } 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 fb65ca3564..a600c8ef3d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -21,8 +21,7 @@ module Elasticsearch module API module Actions - # Performs an update on every document in the index without changing the source, - # for example to pick up a mapping change. + # Update documents # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :analyzer The analyzer to use for the query string @@ -59,7 +58,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition using the Query DSL # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html # def update_by_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'update_by_query' } 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 801ed1bcd4..70379d2eb7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Update By Query operation. + # Throttle an update by query operation # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html#docs-update-by-query-rethrottle # def update_by_query_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'update_by_query_rethrottle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb index 6539662686..caa0e9d41d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Watcher module Actions - # Acknowledges a watch, manually throttling the execution of the watch's actions. + # Acknowledge a watch # # @option arguments [String] :watch_id Watch ID # @option arguments [List] :action_id A comma-separated list of the action ids to be acked # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-ack-watch # def ack_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.ack_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb index 739a1d774d..02352e6e44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Activates a currently inactive watch. + # Activate a watch # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-activate-watch # def activate_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.activate_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb index 645558f549..56ce280919 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Deactivates a currently active watch. + # Deactivate a watch # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-deactivate-watch # def deactivate_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.deactivate_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb index 8a6ae856d7..52c4bafb53 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Removes a watch from Watcher. + # Delete a watch # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-delete-watch # def delete_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.delete_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb index 72d49ad08b..b18c5635af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Watcher module Actions - # Forces the execution of a stored watch. + # Run a watch # # @option arguments [String] :id Watch ID # @option arguments [Boolean] :debug indicates whether the watch should execute in debug mode # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Execution control # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-execute-watch # def execute_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.execute_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb index 00eb7f13f6..547fa1dc06 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Retrieve settings for the watcher system index + # Get Watcher index settings # # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-settings # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb index bb2f184baa..200d2afc9d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Retrieves a watch by its ID. + # Get a watch # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-watch # def get_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb index 111294f4e5..0ded8efd98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Watcher module Actions - # Creates a new watch, or updates an existing one. + # Create or update a watch # # @option arguments [String] :id Watch ID # @option arguments [Boolean] :active Specify whether the watch is in/active by default @@ -30,9 +30,9 @@ module Actions # @option arguments [Number] :if_seq_no only update the watch if the last operation that has changed the watch has the specified sequence number # @option arguments [Number] :if_primary_term only update the watch if the last operation that has changed the watch has the specified primary term # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The watch + # @option arguments [Hash] :body The watch (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-put-watch # def put_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.put_watch' } @@ -42,6 +42,7 @@ def put_watch(arguments = {}) end request_opts[:defined_params] = defined_params unless defined_params.empty? + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] arguments = arguments.clone diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb index 83d9bc0570..7e3c702b38 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Retrieves stored watches. + # Query watches # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body From, size, query, sort and search_after # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-query-watches # def query_watches(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.query_watches' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb index ef2b8ea8e3..0d3a1747ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Starts Watcher if it is not already running. + # Start the watch service # # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start # def start(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.start' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb index 4ef01863df..43aa9981cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Watcher module Actions - # Retrieves the current Watcher metrics. + # Get Watcher statistics # # @option arguments [List] :metric Controls what additional stat metrics should be include in the response (options: _all, queued_watches, current_watches, pending_watches) # @option arguments [Boolean] :emit_stacktraces Emits stack traces of currently running watches # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb index 2f112aedd6..5c4b5d02aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Stops Watcher if it is running. + # Stop the watch service # # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stop # def stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.stop' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb index b316761c9e..c14590234c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Watcher module Actions - # Update settings for the watcher system index + # Update Watcher index settings # # @option arguments [Time] :timeout Specify timeout for waiting for acknowledgement from all nodes # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object with the new index settings (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-update-settings # def update_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.update_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb index 6074bf9ac0..1122b7ff1a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb @@ -22,13 +22,14 @@ module Elasticsearch module API module XPack module Actions - # Retrieves information about the installed X-Pack features. + # Get information # + # @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true. # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/info-api.html # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'xpack.info' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb index 2317ef931e..f0ef64d9fb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module XPack module Actions - # Retrieves usage information about the installed X-Pack features. + # Get usage information # # @option arguments [Time] :master_timeout Specify timeout for watch write operation # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack # def usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'xpack.usage' } diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index e43ee587d7..0036171c9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -17,6 +17,6 @@ module Elasticsearch module API - VERSION = '8.14.0'.freeze + VERSION = '8.19.1'.freeze end end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_delete_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_delete_spec.rb new file mode 100644 index 0000000000..2eb85ef6eb --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_delete_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.esql#async_query_delete' do + let(:expected_args) do + [ + 'DELETE', + '_query/async/foo', + {}, + nil, + {}, + { defined_params: {id: 'foo' }, endpoint: 'esql.async_query_delete' } + ] + end + + it 'performs the request' do + expect(client_double.esql.async_query_delete(id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_stop_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_stop_spec.rb new file mode 100644 index 0000000000..48f61e409f --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/esql/async_query_stop_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.esql#async_query_stop' do + let(:expected_args) do + [ + 'POST', + '_query/async/foo/stop', + {}, + nil, + {}, + { endpoint: 'esql.async_query_stop', defined_params: { id: 'foo' } } + ] + end + + it 'performs the request' do + expect(client_double.esql.async_query_stop(id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/indices/delete_data_stream_options_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/indices/delete_data_stream_options_spec.rb new file mode 100644 index 0000000000..74c67902e7 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/indices/delete_data_stream_options_spec.rb @@ -0,0 +1,37 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.indices.delete_data_stream_options' do + let(:expected_args) do + [ + 'DELETE', + '_data_stream/foo/_options', + {}, + nil, + {}, + { endpoint: 'indices.delete_data_stream_options', defined_params: { name: 'foo' } } + ] + end + + let(:index) { 'foo' } + + it 'performs the request' do + expect(client_double.indices.delete_data_stream_options(name: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_lifecycle_stats_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_lifecycle_stats_spec.rb new file mode 100644 index 0000000000..8938b5a156 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_lifecycle_stats_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.indices#get_data_lifecycle_stats' do + let(:expected_args) do + [ + 'GET', + '_lifecycle/stats', + {}, + nil, + {}, + { endpoint: 'indices.get_data_lifecycle_stats' } + ] + end + + it 'performs the request' do + expect(client_double.indices.get_data_lifecycle_stats).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_stream_options_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_stream_options_spec.rb new file mode 100644 index 0000000000..ce5d08ea4b --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_stream_options_spec.rb @@ -0,0 +1,37 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.indices.get_data_stream_options' do + let(:expected_args) do + [ + 'GET', + '_data_stream/foo/_options', + {}, + nil, + {}, + { endpoint: 'indices.get_data_stream_options', defined_params: { name: 'foo' } } + ] + end + + let(:index) { 'foo' } + + it 'performs the request' do + expect(client_double.indices.get_data_stream_options(name: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_stream_settings_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_stream_settings_spec.rb new file mode 100644 index 0000000000..4fa6057618 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_stream_settings_spec.rb @@ -0,0 +1,37 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.indices.get_data_stream_settings' do + let(:expected_args) do + [ + 'GET', + '_data_stream/foo/_settings', + {}, + nil, + {}, + { endpoint: 'indices.get_data_stream_settings', defined_params: { name: 'foo' } } + ] + end + + let(:index) { 'foo' } + + it 'performs the request' do + expect(client_double.indices.get_data_stream_settings(name: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_stream_options_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_stream_options_spec.rb new file mode 100644 index 0000000000..61e3445470 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_stream_options_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.cluster#put_data_stream_options' do + let(:expected_args) do + [ + 'PUT', + '_data_stream/foo/_options', + {}, + nil, + {}, + { endpoint: 'indices.put_data_stream_options', defined_params: { name: 'foo' } } + ] + end + + it 'performs the request' do + expect(client_double.indices.put_data_stream_options(name: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_stream_settings_spec.rb similarity index 75% rename from elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb rename to elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_stream_settings_spec.rb index 68cb2b635e..cfcd169e01 100644 --- a/elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb +++ b/elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_stream_settings_spec.rb @@ -17,22 +17,19 @@ require 'spec_helper' -describe 'client.connector#last_sync' do +describe 'client.indices#put_data_stream_settings' do let(:expected_args) do [ 'PUT', - '_connector/foo/_last_sync', + '_data_stream/foo/_settings', {}, {}, {}, - { - :defined_params=>{ connector_id: 'foo' }, - endpoint: 'connector.last_sync' - } + { endpoint: 'indices.put_data_stream_settings', defined_params: { name: 'foo' } } ] end it 'performs the request' do - expect(client_double.connector.last_sync(connector_id: 'foo', body: {})).to be_a Elasticsearch::API::Response + expect(client_double.indices.put_data_stream_settings(name: 'foo', body: {})).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/indices/resolve_cluster_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/indices/resolve_cluster_spec.rb index 3da0771413..a4389d26b8 100644 --- a/elasticsearch-api/spec/elasticsearch/api/actions/indices/resolve_cluster_spec.rb +++ b/elasticsearch-api/spec/elasticsearch/api/actions/indices/resolve_cluster_spec.rb @@ -17,16 +17,15 @@ require 'spec_helper' -describe 'client.indices#delete_alias' do - +describe 'client.indices#resolve_cluster' do let(:expected_args) do [ 'GET', - '_resolve/cluster/foo', + path, {}, nil, {}, - { defined_params: { name: 'foo'}, endpoint: 'indices.resolve_cluster' } + otel ] end @@ -34,16 +33,22 @@ let(:client) do Class.new { include Elasticsearch::API }.new end + let(:path) { '_resolve/cluster' } + let(:otel) do + { endpoint: 'indices.resolve_cluster' } + end - it 'raises an exception' do - expect { - client.indices.resolve_cluster - }.to raise_exception(ArgumentError) + it 'performs the request' do + expect(client_double.indices.resolve_cluster).to be_a Elasticsearch::API::Response end end - context 'when name is specified' do + let(:path) { '_resolve/cluster/foo' } + let(:otel) do + { defined_params: { name: 'foo' }, endpoint: 'indices.resolve_cluster' } + end + it 'performs the request' do expect(client_double.indices.resolve_cluster(name: 'foo')).to be_a Elasticsearch::API::Response end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/chat_completion_unified_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/chat_completion_unified_spec.rb new file mode 100644 index 0000000000..6abc29076e --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/chat_completion_unified_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.chat_completion_unified' do + let(:expected_args) do + [ + 'POST', + '_inference/chat_completion/bar/_stream', + {}, + nil, + {}, + { defined_params: { inference_id: 'bar' }, + endpoint: 'inference.chat_completion_unified' } + ] + end + + it 'performs the request' do + expect(client_double.inference.chat_completion_unified(inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/completion_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/completion_spec.rb new file mode 100644 index 0000000000..8817e72a32 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/completion_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.completion' do + let(:expected_args) do + [ + 'POST', + '_inference/completion/bar', + {}, + nil, + {}, + { defined_params: { inference_id: 'bar' }, + endpoint: 'inference.completion' } + ] + end + + it 'performs the request' do + expect(client_double.inference.completion(inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_alibabacloud_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_alibabacloud_spec.rb new file mode 100644 index 0000000000..0ac550822f --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_alibabacloud_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_alibabacloud' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { alibabacloud_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_alibabacloud' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_alibabacloud(task_type: 'foo', alibabacloud_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_amazonbedrock_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_amazonbedrock_spec.rb new file mode 100644 index 0000000000..23d5b57c39 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_amazonbedrock_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_amazonbedrock' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { amazonbedrock_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_amazonbedrock' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_amazonbedrock(task_type: 'foo', amazonbedrock_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_amazonsagemaker_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_amazonsagemaker_spec.rb new file mode 100644 index 0000000000..2d5a686e43 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_amazonsagemaker_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_amazonsagemaker' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { amazonsagemaker_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_amazonsagemaker' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_amazonsagemaker(task_type: 'foo', amazonsagemaker_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_anthropic_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_anthropic_spec.rb new file mode 100644 index 0000000000..3f4c22cbba --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_anthropic_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_anthropic' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { anthropic_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_anthropic' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_anthropic(task_type: 'foo', anthropic_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_azureaistudio_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_azureaistudio_spec.rb new file mode 100644 index 0000000000..add3ed7eec --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_azureaistudio_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_azureaistudio' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { azureaistudio_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_azureaistudio' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_azureaistudio(task_type: 'foo', azureaistudio_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_azureopenai_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_azureopenai_spec.rb new file mode 100644 index 0000000000..ca0ade65b7 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_azureopenai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_azureopenai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { azureopenai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_azureopenai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_azureopenai(task_type: 'foo', azureopenai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_cohere_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_cohere_spec.rb new file mode 100644 index 0000000000..7eb82de752 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_cohere_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_cohere' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { cohere_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_cohere' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_cohere(task_type: 'foo', cohere_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_custom_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_custom_spec.rb new file mode 100644 index 0000000000..a409676f1b --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_custom_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_custom' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/baz', + {}, + nil, + {}, + { defined_params: { custom_inference_id: 'baz', task_type: 'foo' }, + endpoint: 'inference.put_custom' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_custom(task_type: 'foo', custom_inference_id: 'baz')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_deepseek_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_deepseek_spec.rb new file mode 100644 index 0000000000..25cbe4e72e --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_deepseek_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_deepseek' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { deepseek_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_deepseek' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_deepseek(task_type: 'foo', deepseek_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_elasticsearch_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_elasticsearch_spec.rb new file mode 100644 index 0000000000..e91a89c850 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_elasticsearch_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_elasticsearch' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { elasticsearch_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_elasticsearch' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_elasticsearch(task_type: 'foo', elasticsearch_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_elser_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_elser_spec.rb new file mode 100644 index 0000000000..1862e22721 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_elser_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_elser' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { elser_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_elser' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_elser(task_type: 'foo', elser_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_googleaistudio_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_googleaistudio_spec.rb new file mode 100644 index 0000000000..22c5284990 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_googleaistudio_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_googleaistudio' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { googleaistudio_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_googleaistudio' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_googleaistudio(task_type: 'foo', googleaistudio_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_googlevertexai_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_googlevertexai_spec.rb new file mode 100644 index 0000000000..ccf6c883bf --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_googlevertexai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_googlevertexai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { googlevertexai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_googlevertexai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_googlevertexai(task_type: 'foo', googlevertexai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_huggingface_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_huggingface_spec.rb new file mode 100644 index 0000000000..8feb11c28e --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_huggingface_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_hugging_face' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { huggingface_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_hugging_face' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_hugging_face(task_type: 'foo', huggingface_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_jinaai_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_jinaai_spec.rb new file mode 100644 index 0000000000..bcbf0e0f00 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_jinaai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_jinaai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { jinaai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_jinaai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_jinaai(task_type: 'foo', jinaai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_mistral_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_mistral_spec.rb new file mode 100644 index 0000000000..2d8d8dbd3f --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_mistral_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_mistral' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { mistral_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_mistral' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_mistral(task_type: 'foo', mistral_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_openai_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_openai_spec.rb new file mode 100644 index 0000000000..b58dd6e568 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_openai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_openai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { openai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_openai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_openai(task_type: 'foo', openai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_voyageai_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_voyageai_spec.rb new file mode 100644 index 0000000000..8bac99b82d --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_voyageai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_voyageai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { voyageai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_voyageai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_voyageai(task_type: 'foo', voyageai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_watsonx_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_watsonx_spec.rb new file mode 100644 index 0000000000..44245b8b02 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/put_watsonx_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_watsonx' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { watsonx_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_watsonx' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_watsonx(task_type: 'foo', watsonx_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/rerank_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/rerank_spec.rb new file mode 100644 index 0000000000..7417cd74fa --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/rerank_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.rerank' do + let(:expected_args) do + [ + 'POST', + '_inference/rerank/foo', + {}, + nil, + {}, + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.rerank' } + ] + end + + it 'performs the request' do + expect(client_double.inference.rerank(inference_id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/sparse_embedding_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/sparse_embedding_spec.rb new file mode 100644 index 0000000000..856dface5a --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/sparse_embedding_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.sparse_embedding' do + let(:expected_args) do + [ + 'POST', + '_inference/sparse_embedding/foo', + {}, + nil, + {}, + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.sparse_embedding' } + ] + end + + it 'performs the request' do + expect(client_double.inference.sparse_embedding(inference_id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/stream_completion_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/stream_completion_spec.rb new file mode 100644 index 0000000000..542b1d9941 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/stream_completion_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.stream_completion' do + let(:expected_args) do + [ + 'POST', + '_inference/completion/foo/_stream', + {}, + nil, + {}, + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.stream_completion' } + ] + end + + it 'performs the request' do + expect(client_double.inference.stream_completion(inference_id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/text_embedding_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/text_embedding_spec.rb new file mode 100644 index 0000000000..e97fda5865 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/text_embedding_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.text_embedding' do + let(:expected_args) do + [ + 'POST', + '_inference/text_embedding/foo', + {}, + nil, + {}, + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.text_embedding' } + ] + end + + it 'performs the request' do + expect(client_double.inference.text_embedding(inference_id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/inference/update_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/inference/update_spec.rb new file mode 100644 index 0000000000..6f29cd0b58 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/inference/update_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.update' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar/_update', + {}, + nil, + {}, + { defined_params: { inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.update' } + ] + end + + it 'performs the request' do + expect(client_double.inference.update(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/ingest/delete_geoip_database_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/delete_geoip_database_spec.rb index 4a3e4e9b6e..a7a3622777 100644 --- a/elasticsearch-api/spec/elasticsearch/api/actions/ingest/delete_geoip_database_spec.rb +++ b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/delete_geoip_database_spec.rb @@ -34,6 +34,6 @@ end it 'performs the request' do - expect(client_double.ingest.delete_geoip_database(id: 'foo', body: {})).to be_a Elasticsearch::API::Response + expect(client_double.ingest.delete_geoip_database(id: 'foo')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/ingest/delete_ip_location_database_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/delete_ip_location_database_spec.rb new file mode 100644 index 0000000000..429faebe9c --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/delete_ip_location_database_spec.rb @@ -0,0 +1,39 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.ingest#delete_ip_location_database' do + let(:expected_args) do + [ + 'DELETE', + '_ingest/ip_location/database/foo', + {}, + nil, + {}, + { defined_params: { id: 'foo' }, endpoint: 'ingest.delete_ip_location_database' } + ] + end + + let(:client) do + Class.new { include Elasticsearch::API }.new + end + + it 'performs the request' do + expect(client_double.ingest.delete_ip_location_database(id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/ingest/get_ip_location_database_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/get_ip_location_database_spec.rb new file mode 100644 index 0000000000..41c356c3d3 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/get_ip_location_database_spec.rb @@ -0,0 +1,39 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.ingest#get_ip_location_database' do + let(:expected_args) do + [ + 'GET', + '_ingest/ip_location/database/foo', + {}, + nil, + {}, + { defined_params: { id: 'foo' }, endpoint: 'ingest.get_ip_location_database' } + ] + end + + let(:client) do + Class.new { include Elasticsearch::API }.new + end + + it 'performs the request' do + expect(client_double.ingest.get_ip_location_database(id: 'foo', body: {})).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/ingest/put_ip_location_database_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/put_ip_location_database_spec.rb new file mode 100644 index 0000000000..6e3ea29c77 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/ingest/put_ip_location_database_spec.rb @@ -0,0 +1,45 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.ingest#put_ip_location_database' do + let(:expected_args) do + [ + 'PUT', + '_ingest/ip_location/database/foo', + {}, + {}, + {}, + { defined_params: { id: 'foo' }, endpoint: 'ingest.put_ip_location_database' } + ] + end + + let(:client) do + Class.new { include Elasticsearch::API }.new + end + + it 'requires the :id argument' do + expect { + client.ingest.put_ip_location_database + }.to raise_exception(ArgumentError) + end + + it 'performs the request' do + expect(client_double.ingest.put_ip_location_database(id: 'foo', body: {})).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/query_rules/test_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/query_rules/test_spec.rb new file mode 100644 index 0000000000..294013680f --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/query_rules/test_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.query_rules#test' do + let(:expected_args) do + [ + 'POST', + '_query_rules/foo/_test', + {}, + {}, + {}, + { defined_params: { ruleset_id: 'foo' }, endpoint: 'query_rules.test' } + ] + end + + it 'performs the request' do + expect(client_double.query_rules.test(ruleset_id: 'foo', body: {})).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/security/delegate_pki_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/security/delegate_pki_spec.rb new file mode 100644 index 0000000000..d21418f212 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/security/delegate_pki_spec.rb @@ -0,0 +1,39 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#security#delegate_pki' do + let(:expected_args) do + [ + 'POST', + '_security/delegate_pki', + params, + {}, + {}, + { endpoint: 'security.delegate_pki' } + ] + end + + let(:params) do + {} + end + + it 'performs the request' do + expect(client_double.security.delegate_pki(body: {})).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/transform/set_upgrade_mode_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/transform/set_upgrade_mode_spec.rb new file mode 100644 index 0000000000..9dd1b158c1 --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/transform/set_upgrade_mode_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.transform#set_upgrade_mode' do + let(:expected_args) do + [ + 'POST', + '_transform/set_upgrade_mode', + {}, + nil, + {}, + { endpoint: 'transform.set_upgrade_mode' } + ] + end + + it 'performs the request' do + expect(client_double.transform.set_upgrade_mode).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/perform_request_spec.rb b/elasticsearch-api/spec/elasticsearch/api/perform_request_spec.rb index a075ce257d..5b9690b35e 100644 --- a/elasticsearch-api/spec/elasticsearch/api/perform_request_spec.rb +++ b/elasticsearch-api/spec/elasticsearch/api/perform_request_spec.rb @@ -23,7 +23,21 @@ describe 'Perform request args' do Elasticsearch::API::FilesHelper.files.each do |filepath| spec = Elasticsearch::API::EndpointSpec.new(filepath) - next if spec.module_namespace.flatten.first == '_internal' + next if spec.module_namespace.flatten.first == '_internal' || spec.visibility != 'public' + + # Skip testing if the method hasn't been added to the client yet: + client = Elasticsearch::Client.new + implemented = if spec.module_namespace.empty? + client.public_methods.include?(spec.method_name.to_sym) + else + client.public_methods.include?(spec.module_namespace[0].to_sym) && + client.send(spec.module_namespace[0]).methods.include?(spec.method_name.to_sym) + end + unless implemented + name = spec.module_namespace.empty? ? spec.method_name : "#{spec.module_namespace[0]}.#{spec.method_name}" + Logger.new($stdout).info("Method #{name} not implemented yet") + next + end # These are the path parts defined by the user in the method argument defined_path_parts = spec.path_params.inject({}) do |params, part| diff --git a/elasticsearch-api/spec/rest_api/rest_api_yaml_spec.rb b/elasticsearch-api/spec/rest_api/rest_api_yaml_spec.rb index 98e48c7f8e..9200dae676 100644 --- a/elasticsearch-api/spec/rest_api/rest_api_yaml_spec.rb +++ b/elasticsearch-api/spec/rest_api/rest_api_yaml_spec.rb @@ -82,6 +82,9 @@ def skip_test?(test) # ./run_task_groups.rb run_rspec_matchers_on_task_group(task_group, test) end + rescue StandardError => e + LOGGER.error e + raise e end end end diff --git a/elasticsearch-api/spec/rest_api/skipped_tests_free.yml b/elasticsearch-api/spec/rest_api/skipped_tests_free.yml index dfd8e2563c..a68ba9285c 100644 --- a/elasticsearch-api/spec/rest_api/skipped_tests_free.yml +++ b/elasticsearch-api/spec/rest_api/skipped_tests_free.yml @@ -150,3 +150,114 @@ - :file: 'simulate.ingest/10_basic.yml' :description: 'Test mapping validation from templates' +- + :file: 'indices.split/40_routing_partition_size.yml' + :description: '*' +- + :file: 'ingest_geoip/40_geoip_databases.yml' + :description: 'Test adding, getting, and removing geoip databases' +- + :file: 'ingest_geoip/50_ip_lookup_processor.yml' + :description: '*' +- + :file: 'ingest_geoip/60_ip_location_databases.yml' + :description: '*' +- + :file: 'index/91_metrics_no_subobjects.yml' + :description: 'Metrics object indexing with synthetic source' +- + :file: 'indices.create/20_synthetic_source.yml' + :description: '*' +- + :file: 'indices.create/21_synthetic_source_stored.yml' + :description: '*' +- + :file: 'indices.put_mapping/10_basic.yml' + :description: 'disabling synthetic source fails' +- + :file: 'logsdb/20_source_mapping.yml' + :description: 'synthetic _source is default' +- + :file: 'index/92_metrics_auto_subobjects.yml' + :description: 'Metrics object indexing with synthetic source' +- + :file: 'tsdb/20_mapping.yml' + :description: 'Synthetic source' +- + :file: 'search.highlight/50_synthetic_source.yml' + :description: 'text multi fvh source order' +- + :file: 'search.highlight/50_synthetic_source.yml' + :description: 'text multi fvh score order' +- + :file: 'update/100_synthetic_source.yml' + :description: 'stored text' +- + :file: 'get/100_synthetic_source.yml' + :description: 'fetch without refresh also produces synthetic source' +- + :file: 'update/100_synthetic_source.yml' + :description: 'stored text' +- + :file: 'update/100_synthetic_source.yml' + :description: 'keyword' +- + :file: 'update/100_synthetic_source.yml' + :description: 'fetch without refresh also produces synthetic source' +- + :file: 'get/100_synthetic_source.yml' + :description: 'flattened field' +- + :file: 'get/100_synthetic_source.yml' + :description: 'flattened field with ignore_above and arrays' +- + :file: 'range/20_synthetic_source.yml' + :description: '*' +- + :file: 'logsdb/20_source_mapping.yml' + :description: 'disabled _source is not supported' +- + :file: 'logsdb/20_source_mapping.yml' + :description: 'include/exclude is not supported with synthetic _source' +- + :file: 'tsdb/20_mapping.yml' + :description: 'disabled source is not supported' +- + :file: 'tsdb/20_mapping.yml' + :description: 'source include/exclude' +- + :file: 'cluster.stats/40_source_modes.yml' + :description: 'test source modes' +- + :file: 'search/520_fetch_fields.yml' + :description: 'fetch _seq_no via fields' +- + :file: 'indices.recovery/20_synthetic_source.yml' + :description: 'test recovery empty index with use_synthetic_source' +- + :file: 'indices.create/10_basic.yml' + :description: 'Create lookup index' +- + :file: 'indices.create/10_basic.yml' + :description: 'Create lookup index with one shard' +- + :file: 'nodes.stats/11_indices_metrics.yml' + :description: 'indices mappings exact count test for indices level' +- + :file: 'tsdb/160_nested_fields.yml' + :description: '*' +- + :file: 'data_stream/10_basic.yml' + :description: '*' +- + :file: 'data_stream/150_tsdb.yml' + :description: '*' +- + :file: 'data_stream/190_failure_store_redirection.yml' + :description: '*' +- + :file: 'data_stream/240_data_stream_settings.yml' + :description: '*' +- + :file: 'streams/logs/10_basic.yml' + :description: '*' diff --git a/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml b/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml index 1a4c3ca323..a8fd2c5fa9 100644 --- a/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml +++ b/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml @@ -49,7 +49,9 @@ - :file: 'snapshot/10_basic.yml' :description: 'Create a source only snapshot and then restore it' - +- + :file: 'snapshot/10_basic.yml' + :description: 'Failed to snapshot indices with synthetic source' - :file: 'token/10_basic.yml' :description: "Test invalidate user's tokens" @@ -212,3 +214,208 @@ - :file: 'esql/180_match_operator.yml' :description: '*' +- + :file: 'esql/60_usage.yml' + :description: 'Basic ESQL usage output (telemetry) non-snapshot version' +- + :file: 'wildcard/30_ignore_above_synthetic_source.yml' + :description: 'wildcard field type ignore_above' +- + :file: 'wildcard/20_ignore_above_stored_source.yml' + :description: 'wildcard field type ignore_above' +- + :file: 'esql/150_lookup.yml' + :description: '*' +# TODO: once migrate is available in spec +- + :file: 'migrate/10_reindex.yml' + :description: '*' +- + :file: 'migrate/20_reindex_status.yml' + :description: '*' +- + :file: 'migrate/30_create_from.yml' + :description: '*' +- + :file: 'esql/60_usage.yml' + :description: 'Basic ESQL usage output (telemetry) snapshot version' +# TODO: 8.19 - 19 June 2025 +- + :file: 'ml/datafeeds_crud.yml' + :description: '*' +- + :file: 'ml/delete_job_force.yml' + :description: '*' +- + :file: 'ml/filter_crud.yml' + :description: '*' +- + :file: 'ml/get_datafeed_stats.yml' + :description: '*' +- + :file: 'ml/get_datafeeds.yml' + :description: '*' +- + :file: 'ml/get_trained_model_stats.yml' + :description: '*' +- + :file: 'ml/inference_crud.yml' + :description: '*' +- + :file: 'ml/job_groups.yml' + :description: '*' +- + :file: 'ml/jobs_crud.yml' + :description: '*' +- + :file: 'ml/jobs_get.yml' + :description: '*' +- + :file: 'ml/jobs_get_stats.yml' + :description: '*' +- + :file: 'ml/preview_data_frame_analytics.yml' + :description: '*' +- + :file: 'ml/preview_datafeed.yml' + :description: '*' +- + :file: 'ml/search_knn_query_vector_builder.yml' + :description: '*' +- + :file: 'ml/set_upgrade_mode.yml' + :description: '*' +- + :file: 'ml/sparse_vector_search.yml' + :description: '*' +- + :file: 'ml/start_data_frame_analytics.yml' + :description: '*' +- + :file: 'ml/start_stop_datafeed.yml' + :description: '*' +- + :file: 'ml/stop_data_frame_analytics.yml' + :description: '*' +- + :file: 'ml/text_embedding_search.yml' + :description: '*' +- + :file: 'ml/text_expansion_search.yml' + :description: '*' +- + :file: 'ml/text_expansion_search_rank_features.yml' + :description: '*' +- + :file: 'ml/text_expansion_search_sparse_vector.yml' + :description: '*' +- + :file: 'ml/trained_model_cat_apis.yml' + :description: '*' +- + :file: 'transform/transforms_crud.yml' + :description: '*' +- + :file: 'transform/transforms_start_stop.yml' + :description: '*' +- + :file: 'transform/transforms_stats.yml' + :description: '*' +- + :file: 'transform/transforms_update.yml' + :description: '*' +- + :file: 'transform/transforms_upgrade.yml' + :description: '*' +# ENDS TODO: 8.19 - 19 June 2025 + +# TODO: 8.19 - 30 June 2025 +- + :file: 'inference/10_semantic_text_field_mapping.yml' + :description: '*' +- + :file: 'inference/10_semantic_text_field_mapping_bwc.yml' + :description: '*' +- + :file: 'inference/25_semantic_text_field_mapping_chunking.yml' + :description: '*' +- + :file: 'inference/25_semantic_text_field_mapping_chunking_bwc.yml' + :description: '*' +- + :file: 'inference/30_semantic_text_inference.yml' + :description: '*' +- + :file: 'inference/30_semantic_text_inference_bwc.yml' + :description: '*' +- + :file: 'inference/40_semantic_text_query.yml' + :description: '*' +- + :file: 'inference/45_semantic_text_match.yml' + :description: '*' +- + :file: 'inference/46_semantic_text_sparse_vector.yml' + :description: '*' +- + :file: 'inference/47_semantic_text_knn.yml' + :description: '*' +- + :file: 'inference/50_semantic_text_query_inference_endpoint_changes.yml' + :description: '*' +- + :file: 'inference/60_semantic_text_inference_update.yml' + :description: '*' +- + :file: 'inference/60_semantic_text_inference_update_bwc.yml' + :description: '*' +- + :file: 'inference/70_semantic_text_exists_query.yml' + :description: '*' +- + :file: 'inference/70_text_similarity_rank_retriever.yml' + :description: '*' +- + :file: 'inference/80_random_rerank_retriever.yml' + :description: '*' +- + :file: 'inference/90_semantic_text_highlighter.yml' + :description: '*' +- + :file: 'inference/90_semantic_text_highlighter_bwc.yml' + :description: '*' +# ENDS TODO: 8.19 - 30 June 2025 +# Issue with regexp parsing on test runner: +- + :file: 'esql/60_enrich.yml' + :description: 'Enrich with brackets in policy name' +- + :file: 'mustache/10_webhook.yml' + :description: '*' +- + :file: 'mustache/50_webhook_url_escaping.yml' + :description: '*' +- + :file: 'watcher/execute_watch/10_basic.yml' + :description: '*' +- + :file: 'watcher/execute_watch/60_http_input.yml' + :description: '*' +- + :file: 'watcher/settings_endpoints/10_watcher_settings.yml' + :description: '*' +- + :file: 'watcher/execute_watch/30_throttled.yml' + :description: '*' +- + :file: 'watcher/execute_watch/40_ignore_condition.yml' + :description: '*' +- + :file: 'watcher/execute_watch/50_action_mode.yml' + :description: '*' +- + :file: 'watcher/put_watch/90_auto_create_index.yml' + :description: '*' +- + :file: 'entsearch/connector/80_connector_update_last_sync_stats.yml' + :description: '*' diff --git a/elasticsearch-api/spec/spec_helper.rb b/elasticsearch-api/spec/spec_helper.rb index e2ad892f05..fe0099ed41 100644 --- a/elasticsearch-api/spec/spec_helper.rb +++ b/elasticsearch-api/spec/spec_helper.rb @@ -59,6 +59,7 @@ def self.included(context) RSpec.configure do |config| config.include(HelperModule) config.add_formatter('documentation') + config.filter_run_excluding skip: true if defined?(JRUBY_VERSION) config.add_formatter('RSpec::Core::Formatters::HtmlFormatter', "tmp/elasticsearch-#{ENV['TEST_SUITE']}-jruby-#{JRUBY_VERSION}.html") else diff --git a/elasticsearch-api/spec/unit/actions/async_search/delete_spec.rb b/elasticsearch-api/spec/unit/actions/async_search/delete_spec.rb new file mode 100644 index 0000000000..8db2fb3297 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/async_search/delete_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'async_search.delete' do + let(:expected_args) do + [ + 'DELETE', + '_async_search/foo', + {}, + nil, + {}, + { endpoint: 'count' } + ] + end + + it 'performs the request' do + expect(client_double.async_search.delete(id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/async_search/get_spec.rb b/elasticsearch-api/spec/unit/actions/async_search/get_spec.rb new file mode 100644 index 0000000000..80d9b84e91 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/async_search/get_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'async_search.delete' do + let(:expected_args) do + [ + 'GET', + '_async_search/foo', + {}, + nil, + {}, + { endpoint: 'count' } + ] + end + + it 'performs the request' do + expect(client_double.async_search.get(id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/async_search/status_spec.rb b/elasticsearch-api/spec/unit/actions/async_search/status_spec.rb new file mode 100644 index 0000000000..66191b44ae --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/async_search/status_spec.rb @@ -0,0 +1,34 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +require 'spec_helper' + +describe 'async_search.delete' do + let(:expected_args) do + [ + 'GET', + '_async_search/status/foo', + {}, + nil, + {}, + { endpoint: 'async_search.status' } + ] + end + + it 'performs the request' do + expect(client_double.async_search.status(id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/async_search/submit_spec.rb b/elasticsearch-api/spec/unit/actions/async_search/submit_spec.rb new file mode 100644 index 0000000000..5c2068e080 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/async_search/submit_spec.rb @@ -0,0 +1,87 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +require 'spec_helper' + +describe 'async_search.submit' do + context 'with no parameters' do + let(:expected_args) do + [ + 'POST', + '_async_search', + {}, + nil, + {}, + { endpoint: 'async_search.submit' } + ] + end + + it 'performs the request' do + expect(client_double.async_search.submit).to be_a Elasticsearch::API::Response + end + end + + context 'with index' do + let(:expected_args) do + [ + 'DELETE', + '_async_search/foo', + {}, + nil, + {}, + { endpoint: 'count' } + ] + end + + it 'performs the request' do + expect(client_double.async_search.submit).to be_a Elasticsearch::API::Response + end + end +end + +require 'test_helper' + +module Elasticsearch + module Test + class XPackAsyncSearchSubmit < Minitest::Test + subject { FakeClient.new } + + context 'XPack: Async Search Submit' do + should 'perform correct request' do + subject.expects(:perform_request).with do |method, url, params, body| + assert_equal('POST', method) + assert_equal('_async_search', url) + assert_equal({}, params) + assert_nil(body) + end.returns(FakeResponse.new) + + subject.async_search.submit + end + + should 'perform correct request with index' do + subject.expects(:perform_request).with do |method, url, params, body| + assert_equal('POST', method) + assert_equal('foo/_async_search', url) + assert_equal({}, params) + assert_nil(body) + end.returns(FakeResponse.new) + + subject.async_search.submit(index: 'foo') + end + end + end + end +end diff --git a/elasticsearch-api/spec/yaml-test-runner/run.rb b/elasticsearch-api/spec/yaml-test-runner/run.rb index c25c3a71c3..f477f3d56a 100644 --- a/elasticsearch-api/spec/yaml-test-runner/run.rb +++ b/elasticsearch-api/spec/yaml-test-runner/run.rb @@ -64,4 +64,7 @@ current_branch = `git rev-parse --abbrev-ref HEAD`.strip branch = current_branch.match(/[0-9]\.[0-9]+/)&.[](0) || ENV['ES_YAML_TESTS_BRANCH'] || nil Elasticsearch::Tests::Downloader::run(tests_path, branch) -Elasticsearch::Tests::TestRunner.new(CLIENT, tests_path, logger).run + +runner = Elasticsearch::Tests::TestRunner.new(CLIENT, tests_path, logger) +runner.add_tests_to_skip('inference/10_basic.yml') # TODO: Extract into file +runner.run diff --git a/elasticsearch-api/utils/Gemfile b/elasticsearch-api/utils/Gemfile index 6f6f061b67..d7a0fe4d5a 100644 --- a/elasticsearch-api/utils/Gemfile +++ b/elasticsearch-api/utils/Gemfile @@ -24,5 +24,5 @@ gem 'multi_json' gem 'pry' gem 'thor' -gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) && Gem::Version.new(JRUBY_VERSION) <= Gem::Version.new('9.4') +gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) gem 'debug' unless defined?(JRUBY_VERSION) diff --git a/elasticsearch-api/utils/thor/endpoint_spec.rb b/elasticsearch-api/utils/thor/endpoint_spec.rb index 30a06a5562..a309cbb9e2 100644 --- a/elasticsearch-api/utils/thor/endpoint_spec.rb +++ b/elasticsearch-api/utils/thor/endpoint_spec.rb @@ -24,6 +24,23 @@ module API class EndpointSpec include EndpointSpecifics + # These APIs are private, but were added in 8.x since the generator didn't consider + # visibility. They will be removed in 9.x since we're using a different generator that + # considers visibility. But new private APIs code won't be generated for the client. + EXCLUDED_8X = [ + 'autoscaling.delete_autoscaling_policy', 'autoscaling.get_autoscaling_capacity', + 'autoscaling.get_autoscaling_policy', 'autoscaling.put_autoscaling_policy', 'capabilities', + 'connector.secret_delete', 'connector.secret_get', 'connector.secret_post', + 'connector.secret_put', 'fleet.delete_secret', 'fleet.get_secret', 'fleet.post_secret', + 'ml.validate', 'ml.validate_detector', 'monitoring.bulk', 'profiling.flamegraph', + 'profiling.stacktraces', 'profiling.status', 'profiling.topn_functions', + 'security.activate_user_profile', 'security.disable_user_profile', + 'security.enable_user_profile', 'security.get_user_profile', + 'security.has_privileges_user_profile', 'security.suggest_user_profiles', + 'security.update_user_profile_data', 'shutdown.delete_node', 'shutdown.get_node', + 'shutdown.put_node' + ].freeze + def initialize(filepath) @path = Pathname(filepath) json = MultiJson.load(File.read(@path)) @@ -31,14 +48,14 @@ def initialize(filepath) @endpoint_name = json.keys.first full_namespace = parse_full_namespace - @namespace_depth = full_namespace.size > 0 ? full_namespace.size - 1 : 0 + @namespace_depth = full_namespace.size.positive? ? full_namespace.size - 1 : 0 @module_namespace = full_namespace[0, @namespace_depth] @method_name = full_namespace.last @path_parts = parse_endpoint_parts(@spec) @params = @spec['params'] || {} @paths = @spec['url']['paths'].map { |b| b['path'] } if @spec['url'] - @path_params = path_variables.flatten.uniq.collect(&:to_sym) + @path_params = path_variables.flatten.uniq.collect(&:to_sym) @http_method = parse_http_method(@spec) @deprecation_note = @spec['url']['paths'].last&.[]('deprecated') @http_path = parse_http_path(@paths) @@ -71,6 +88,16 @@ def stability @spec['stability'] end + def visibility + @spec['visibility'] + end + + def skippable? + return true if module_namespace.flatten.first == '_internal' + + visibility != 'public' && !EXCLUDED_8X.include?(endpoint_name) + end + # Function that adds the listified h param code def specific_params super(@module_namespace.first, @method_name) diff --git a/elasticsearch-api/utils/thor/endpoint_specifics.rb b/elasticsearch-api/utils/thor/endpoint_specifics.rb index 5dc4d6fa65..eea5f46cdd 100644 --- a/elasticsearch-api/utils/thor/endpoint_specifics.rb +++ b/elasticsearch-api/utils/thor/endpoint_specifics.rb @@ -39,6 +39,7 @@ module EndpointSpecifics indices.delete indices.delete_template indices.flush_synced + query_rules.delete_ruleset security.get_role security.get_user snapshot.delete diff --git a/elasticsearch-api/utils/thor/generate_source.rb b/elasticsearch-api/utils/thor/generate_source.rb index df60b0004c..acdf8bb41d 100644 --- a/elasticsearch-api/utils/thor/generate_source.rb +++ b/elasticsearch-api/utils/thor/generate_source.rb @@ -68,7 +68,7 @@ def generate_source @spec = EndpointSpec.new(filepath) say_status 'json', @spec.path, :yellow # Don't generate code for internal APIs: - next if @spec.module_namespace.flatten.first == '_internal' + next if @spec.skippable? path_to_file = output.join(@spec.module_namespace.join('/')).join("#{@spec.method_name}.rb") dir = output.join(@spec.module_namespace.join('/')) diff --git a/elasticsearch-api/utils/thor/generator/docs_helper.rb b/elasticsearch-api/utils/thor/generator/docs_helper.rb index fc41b885da..6e21174182 100644 --- a/elasticsearch-api/utils/thor/generator/docs_helper.rb +++ b/elasticsearch-api/utils/thor/generator/docs_helper.rb @@ -23,7 +23,7 @@ def docs(name, info) info['type'] = 'String' if info['type'] == 'enum' # Rename 'enums' to 'strings' info['type'] = 'Integer' if info['type'] == 'int' # Rename 'int' to 'Integer' tipo = info['type'] ? info['type'].capitalize : 'String' - description = info['description'] ? info['description'].strip : '[TODO]' + description = info['description'] ? info['description'].strip.gsub("\n", ' ') : '[TODO]' options = info['options'] ? "(options: #{info['options'].join(', ').strip})" : nil required = info['required'] ? '(*Required*)' : '' deprecated = info['deprecated'] ? '*Deprecated*' : '' diff --git a/elasticsearch/elasticsearch.gemspec b/elasticsearch/elasticsearch.gemspec index d7dbdc900f..e296226f6e 100644 --- a/elasticsearch/elasticsearch.gemspec +++ b/elasticsearch/elasticsearch.gemspec @@ -46,7 +46,7 @@ Gem::Specification.new do |s| s.required_ruby_version = '>= 2.5' s.add_dependency 'elastic-transport', '~> 8.3' - s.add_dependency 'elasticsearch-api', '8.14.0' + s.add_dependency 'elasticsearch-api', '8.19.1' s.add_development_dependency 'base64' s.add_development_dependency 'bundler' diff --git a/elasticsearch/lib/elasticsearch.rb b/elasticsearch/lib/elasticsearch.rb index 6b1639f383..5fb6750931 100644 --- a/elasticsearch/lib/elasticsearch.rb +++ b/elasticsearch/lib/elasticsearch.rb @@ -160,6 +160,7 @@ def elasticsearch_validation_request def sent_user_agent?(arguments) return unless (headers = arguments&.[](:transport_options)&.[](:headers)) + !!headers.keys.detect { |h| h =~ /user-?_?agent/ } end diff --git a/elasticsearch/lib/elasticsearch/helpers/scroll_helper.rb b/elasticsearch/lib/elasticsearch/helpers/scroll_helper.rb index 747750cfa6..ead41314ac 100644 --- a/elasticsearch/lib/elasticsearch/helpers/scroll_helper.rb +++ b/elasticsearch/lib/elasticsearch/helpers/scroll_helper.rb @@ -43,12 +43,8 @@ def initialize(client, index, body, scroll = '1m') # @yieldparam document [Hash] yields a document found in the search hits. # def each(&block) - @docs = [] - @scroll_id = nil - refresh_docs - for doc in @docs do - refresh_docs - yield doc + until (docs = results).empty? + docs.each(&block) end clear end @@ -70,17 +66,11 @@ def results # def clear @client.clear_scroll(body: { scroll_id: @scroll_id }) if @scroll_id - @docs = [] + @scroll_id = nil end private - def refresh_docs - @docs ||= [] - @docs << results - @docs.flatten! - end - def initial_search response = @client.search(index: @index, scroll: @scroll, body: @body) @scroll_id = response['_scroll_id'] @@ -88,7 +78,7 @@ def initial_search end def scroll_request - @client.scroll(body: {scroll: @scroll, scroll_id: @scroll_id})['hits']['hits'] + @client.scroll(body: { scroll: @scroll, scroll_id: @scroll_id })['hits']['hits'] end end end diff --git a/elasticsearch/lib/elasticsearch/version.rb b/elasticsearch/lib/elasticsearch/version.rb index 099a40a401..a18d6bb476 100644 --- a/elasticsearch/lib/elasticsearch/version.rb +++ b/elasticsearch/lib/elasticsearch/version.rb @@ -16,5 +16,5 @@ # under the License. module Elasticsearch - VERSION = '8.14.0'.freeze + VERSION = '8.19.1'.freeze end diff --git a/elasticsearch/spec/integration/helpers/scroll_helper_spec.rb b/elasticsearch/spec/integration/helpers/scroll_helper_spec.rb index 8cd63f9869..ec59731b54 100644 --- a/elasticsearch/spec/integration/helpers/scroll_helper_spec.rb +++ b/elasticsearch/spec/integration/helpers/scroll_helper_spec.rb @@ -18,64 +18,66 @@ require 'elasticsearch/helpers/scroll_helper' context 'Elasticsearch client helpers' do - let(:index) { 'books' } - let(:body) { { size: 12, query: { match_all: {} } } } - let(:scroll_helper) { Elasticsearch::Helpers::ScrollHelper.new(client, index, body) } + context 'ScrollHelper' do + let(:index) { 'books' } + let(:body) { { size: 12, query: { match_all: {} } } } + let(:scroll_helper) { Elasticsearch::Helpers::ScrollHelper.new(client, index, body) } - before do - documents = [ - { index: { _index: index, data: {name: "Leviathan Wakes", "author": "James S.A. Corey", "release_date": "2011-06-02", "page_count": 561} } }, - { index: { _index: index, data: {name: "Hyperion", "author": "Dan Simmons", "release_date": "1989-05-26", "page_count": 482} } }, - { index: { _index: index, data: {name: "Dune", "author": "Frank Herbert", "release_date": "1965-06-01", "page_count": 604} } }, - { index: { _index: index, data: {name: "Dune Messiah", "author": "Frank Herbert", "release_date": "1969-10-15", "page_count": 331} } }, - { index: { _index: index, data: {name: "Children of Dune", "author": "Frank Herbert", "release_date": "1976-04-21", "page_count": 408} } }, - { index: { _index: index, data: {name: "God Emperor of Dune", "author": "Frank Herbert", "release_date": "1981-05-28", "page_count": 454} } }, - { index: { _index: index, data: {name: "Consider Phlebas", "author": "Iain M. Banks", "release_date": "1987-04-23", "page_count": 471} } }, - { index: { _index: index, data: {name: "Pandora's Star", "author": "Peter F. Hamilton", "release_date": "2004-03-02", "page_count": 768} } }, - { index: { _index: index, data: {name: "Revelation Space", "author": "Alastair Reynolds", "release_date": "2000-03-15", "page_count": 585} } }, - { index: { _index: index, data: {name: "A Fire Upon the Deep", "author": "Vernor Vinge", "release_date": "1992-06-01", "page_count": 613} } }, - { index: { _index: index, data: {name: "Ender's Game", "author": "Orson Scott Card", "release_date": "1985-06-01", "page_count": 324} } }, - { index: { _index: index, data: {name: "1984", "author": "George Orwell", "release_date": "1985-06-01", "page_count": 328} } }, - { index: { _index: index, data: {name: "Fahrenheit 451", "author": "Ray Bradbury", "release_date": "1953-10-15", "page_count": 227} } }, - { index: { _index: index, data: {name: "Brave New World", "author": "Aldous Huxley", "release_date": "1932-06-01", "page_count": 268} } }, - { index: { _index: index, data: {name: "Foundation", "author": "Isaac Asimov", "release_date": "1951-06-01", "page_count": 224} } }, - { index: { _index: index, data: {name: "The Giver", "author": "Lois Lowry", "release_date": "1993-04-26", "page_count": 208} } }, - { index: { _index: index, data: {name: "Slaughterhouse-Five", "author": "Kurt Vonnegut", "release_date": "1969-06-01", "page_count": 275} } }, - { index: { _index: index, data: {name: "The Hitchhiker's Guide to the Galaxy", "author": "Douglas Adams", "release_date": "1979-10-12", "page_count": 180} } }, - { index: { _index: index, data: {name: "Snow Crash", "author": "Neal Stephenson", "release_date": "1992-06-01", "page_count": 470} } }, - { index: { _index: index, data: {name: "Neuromancer", "author": "William Gibson", "release_date": "1984-07-01", "page_count": 271} } }, - { index: { _index: index, data: {name: "The Handmaid's Tale", "author": "Margaret Atwood", "release_date": "1985-06-01", "page_count": 311} } }, - { index: { _index: index, data: {name: "Starship Troopers", "author": "Robert A. Heinlein", "release_date": "1959-12-01", "page_count": 335} } }, - { index: { _index: index, data: {name: "The Left Hand of Darkness", "author": "Ursula K. Le Guin", "release_date": "1969-06-01", "page_count": 304} } }, - { index: { _index: index, data: {name: "The Moon is a Harsh Mistress", "author": "Robert A. Heinlein", "release_date": "1966-04-01", "page_count": 288 } } } - ] - client.bulk(body: documents, refresh: 'wait_for') - end - - after do - client.indices.delete(index: index) - end + before do + documents = [ + { index: { _index: index, data: {name: "Leviathan Wakes", "author": "James S.A. Corey", "release_date": "2011-06-02", "page_count": 561} } }, + { index: { _index: index, data: {name: "Hyperion", "author": "Dan Simmons", "release_date": "1989-05-26", "page_count": 482} } }, + { index: { _index: index, data: {name: "Dune", "author": "Frank Herbert", "release_date": "1965-06-01", "page_count": 604} } }, + { index: { _index: index, data: {name: "Dune Messiah", "author": "Frank Herbert", "release_date": "1969-10-15", "page_count": 331} } }, + { index: { _index: index, data: {name: "Children of Dune", "author": "Frank Herbert", "release_date": "1976-04-21", "page_count": 408} } }, + { index: { _index: index, data: {name: "God Emperor of Dune", "author": "Frank Herbert", "release_date": "1981-05-28", "page_count": 454} } }, + { index: { _index: index, data: {name: "Consider Phlebas", "author": "Iain M. Banks", "release_date": "1987-04-23", "page_count": 471} } }, + { index: { _index: index, data: {name: "Pandora's Star", "author": "Peter F. Hamilton", "release_date": "2004-03-02", "page_count": 768} } }, + { index: { _index: index, data: {name: "Revelation Space", "author": "Alastair Reynolds", "release_date": "2000-03-15", "page_count": 585} } }, + { index: { _index: index, data: {name: "A Fire Upon the Deep", "author": "Vernor Vinge", "release_date": "1992-06-01", "page_count": 613} } }, + { index: { _index: index, data: {name: "Ender's Game", "author": "Orson Scott Card", "release_date": "1985-06-01", "page_count": 324} } }, + { index: { _index: index, data: {name: "1984", "author": "George Orwell", "release_date": "1985-06-01", "page_count": 328} } }, + { index: { _index: index, data: {name: "Fahrenheit 451", "author": "Ray Bradbury", "release_date": "1953-10-15", "page_count": 227} } }, + { index: { _index: index, data: {name: "Brave New World", "author": "Aldous Huxley", "release_date": "1932-06-01", "page_count": 268} } }, + { index: { _index: index, data: {name: "Foundation", "author": "Isaac Asimov", "release_date": "1951-06-01", "page_count": 224} } }, + { index: { _index: index, data: {name: "The Giver", "author": "Lois Lowry", "release_date": "1993-04-26", "page_count": 208} } }, + { index: { _index: index, data: {name: "Slaughterhouse-Five", "author": "Kurt Vonnegut", "release_date": "1969-06-01", "page_count": 275} } }, + { index: { _index: index, data: {name: "The Hitchhiker's Guide to the Galaxy", "author": "Douglas Adams", "release_date": "1979-10-12", "page_count": 180} } }, + { index: { _index: index, data: {name: "Snow Crash", "author": "Neal Stephenson", "release_date": "1992-06-01", "page_count": 470} } }, + { index: { _index: index, data: {name: "Neuromancer", "author": "William Gibson", "release_date": "1984-07-01", "page_count": 271} } }, + { index: { _index: index, data: {name: "The Handmaid's Tale", "author": "Margaret Atwood", "release_date": "1985-06-01", "page_count": 311} } }, + { index: { _index: index, data: {name: "Starship Troopers", "author": "Robert A. Heinlein", "release_date": "1959-12-01", "page_count": 335} } }, + { index: { _index: index, data: {name: "The Left Hand of Darkness", "author": "Ursula K. Le Guin", "release_date": "1969-06-01", "page_count": 304} } }, + { index: { _index: index, data: {name: "The Moon is a Harsh Mistress", "author": "Robert A. Heinlein", "release_date": "1966-04-01", "page_count": 288 } } } + ] + client.bulk(body: documents, refresh: 'wait_for') + end - it 'instantiates a scroll helper' do - expect(scroll_helper).to be_an_instance_of Elasticsearch::Helpers::ScrollHelper - end + after do + client.indices.delete(index: index) + end - it 'searches an index' do - my_documents = [] - while !(documents = scroll_helper.results).empty? - my_documents << documents + it 'instantiates a scroll helper' do + expect(scroll_helper).to be_an_instance_of Elasticsearch::Helpers::ScrollHelper end - expect(my_documents.flatten.size).to eq 24 - end + it 'searches an index' do + my_documents = [] + while !(documents = scroll_helper.results).empty? + my_documents << documents + end - it 'uses enumerable' do - count = 0 - scroll_helper.each { |a| count += 1 } - expect(count).to eq 24 - expect(scroll_helper).to respond_to(:count) - expect(scroll_helper).to respond_to(:reject) - expect(scroll_helper).to respond_to(:uniq) - expect(scroll_helper.map { |a| a['_id'] }.uniq.count).to eq 24 + expect(my_documents.flatten.size).to eq 24 + end + + it 'uses enumerable' do + count = 0 + scroll_helper.each { count += 1 } + expect(count).to eq 24 + expect(scroll_helper).to respond_to(:count) + expect(scroll_helper).to respond_to(:reject) + expect(scroll_helper).to respond_to(:uniq) + expect(scroll_helper.map { |a| a['_id'] }.uniq.count).to eq 24 + end end end diff --git a/rake_tasks/automation.rake b/rake_tasks/automation.rake index 6edce27267..751804e492 100644 --- a/rake_tasks/automation.rake +++ b/rake_tasks/automation.rake @@ -98,7 +98,6 @@ namespace :automation do task :bumpmatrix, :version do |_, args| abort('[!] Required argument [version] missing') unless (version = args[:version]) gh_actions = Dir.glob(File.expand_path('../.github/workflows/*.yml', __dir__)) - files = gh_actions + ['.buildkite/pipeline.yml'] regexp = Regexp.new(/([0-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}?+(-SNAPSHOT)?)/) files.each do |file| @@ -108,10 +107,10 @@ namespace :automation do yaml = YAML.safe_load(content) branch = version.match(/([0-9]+\.[0-9]+)\.[0-9]+.*/)[1] yaml_tests_branch = yaml['steps'][1]['env']['ES_YAML_TESTS_BRANCH'] - next if yaml_tests_branch == 'main' - - content.gsub!(yaml_tests_branch, branch) - puts "[#{yaml_tests_branch}] -> [#{branch}] in #{file.gsub('./', '')}" + unless ['main', '8.x'].include? yaml_tests_branch + content.gsub!(yaml_tests_branch, branch) + puts "[#{yaml_tests_branch}] -> [#{branch}] in #{file.gsub('./', '')}" + end end match = content.match(regexp) next if match.nil?