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 b6577adf92..ffce4becf3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -44,7 +44,7 @@ module Actions # @option arguments [String] :default_operator The default operator for query string query (AND or OR) Server default: or. # @option arguments [String] :df The field to use as default where no field prefix is given in the query string # @option arguments [String, Array] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit - # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 4e704ea7d3..f1fae4b37d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -34,7 +34,7 @@ module Actions # or `:desc` as a suffix to the column name. # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # It supports comma-separated values, such as `open,hidden`. + # It supports comma-separated values, such as `open,hidden`. Server default: all. # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. # If the master node is not available before the timeout expires, the request fails and returns an error. # To indicated that the request should never timeout, you can set it to `-1`. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index c2da534a04..e6819e856a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -37,7 +37,7 @@ module Actions # # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. # Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. + # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. Server default: all. # @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status. # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory. # @option arguments [Boolean] :pri If true, the response only includes information from primary shards. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index 3606817691..765d009eeb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -25,10 +25,9 @@ module Actions # Get task information. # Get information about tasks currently running in the cluster. # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Array] :actions The task action names, which are used to limit the response. # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index f911af0d26..88302fd8fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -32,7 +32,7 @@ module Actions # The cluster status is controlled by the worst index status. # # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`. - # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: all. # @option arguments [String] :level Can be one of cluster, indices or shards. Controls the details level of the health information returned. Server default: cluster. # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index 04204ffa82..60be0a88ec 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -40,11 +40,11 @@ module Actions # @option arguments [String, Array] :metric Limit the information returned to the specified metrics # @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @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) Server default: true. - # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @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 Server default: 30s. + # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked Server default: 30s. # @option arguments [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 e12b7f9abc..3f4ad07411 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb @@ -24,10 +24,9 @@ module Connector module Actions # Check in a connector. # Update the `last_seen` field in the connector and set it to the current timestamp. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be checked in (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 923a58500e..3c74290925 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 @@ -26,10 +26,9 @@ module Actions # Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. # This service runs automatically on Elastic Cloud for Elastic managed 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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 checked in. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 24222d17be..5680b49ef2 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 @@ -29,10 +29,9 @@ module Actions # It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. # This service runs automatically on Elastic Cloud for Elastic managed 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 5664f49c86..74efbe7e0c 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 @@ -26,10 +26,9 @@ module Actions # Set the `error` field for a connector sync job and set its `status` to `error`. # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. # This service runs automatically on Elastic Cloud for Elastic managed 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :connector_sync_job_id The unique identifier for the connector sync job. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 73bb97e6dd..b98de7d517 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 @@ -28,10 +28,9 @@ module Actions # This API is mainly used by the connector service for updating sync job information. # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. # This service runs automatically on Elastic Cloud for Elastic managed 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 3d428f9c95..41f6476914 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 @@ -24,10 +24,9 @@ module Connector module Actions # Activate the connector draft filter. # Activates the valid draft filtering 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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 (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 125e120bb1..cbb15339fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb @@ -26,10 +26,9 @@ module Actions # Set the error field for the connector. # If the error provided in the request body is non-null, the connector’s status is updated to error. # Otherwise, if the error is reset to null, the connector status is updated to connected. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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 (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 49909a69e5..7da71d206f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb @@ -33,10 +33,9 @@ module Actions # However, you can use this API to override the default behavior. # To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. # This service runs automatically on Elastic Cloud for Elastic managed 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 a5a2263b65..9569d77b60 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 @@ -24,10 +24,9 @@ module Connector module Actions # Update the connector draft filtering validation. # Update the draft filtering validation info 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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 (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 97d770373a..1b57746d74 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb @@ -23,10 +23,9 @@ module API module Connector module Actions # 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview 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 (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 8c15d3ed60..e2c7bf50a9 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 @@ -27,7 +27,7 @@ module Actions # For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. # # @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*) - # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*) + # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s. # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 c81cf4d752..9ee2e4d8c4 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 @@ -28,7 +28,7 @@ module Actions # # @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*) # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index. - # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*) + # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s. # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 3fb0e09af5..d78258d46e 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 @@ -27,7 +27,7 @@ module Actions # # @option arguments [String] :task_id The ID for the task. (*Required*) # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. - # To disable throttling, set it to `-1`. + # To disable throttling, set it to `-1`. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb index 8db2232084..58ec011fea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb @@ -24,10 +24,9 @@ module Esql module Actions # Get a specific running ES|QL query information. # Returns an object extended information about a running ES|QL 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :id The query ID (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb index 5cb0a44d42..6f3d861916 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb @@ -24,10 +24,9 @@ module Esql module Actions # Get running ES|QL queries information. # Returns an object containing IDs and other information about the running ES|QL queries. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. 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 b86fe065e1..d6066af5b7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb @@ -33,10 +33,9 @@ module Actions # Using this API resets all features, both those that are built-in and implemented as plugins. # To list the features that will be affected, use the get features API. # IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb index bd722107a6..d7d842396a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb @@ -26,10 +26,9 @@ module Actions # Run several Fleet searches with a single API request. # The API follows the same structure as the multi search API. # However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb index 50a1867f17..ff3b6802cf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb @@ -25,10 +25,9 @@ module Actions # Run a Fleet search. # The purpose of the Fleet search API is to provide an API where the search will be run only # after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*) # @option arguments [Boolean] :allow_no_indices [TODO] diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb index 2c7ff6454f..2bf66b1114 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb @@ -24,10 +24,9 @@ module Indices module Actions # Cancel a migration reindex operation. # Cancel a migration reindex attempt for a data stream or index. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :index The index or data stream name (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb index 6fe37b5c0a..5e77bf5c9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb @@ -24,10 +24,9 @@ module Indices module Actions # Create an index from a source index. # Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :source The source index or data stream name (*Required*) # @option arguments [String] :dest The destination index or data stream name (*Required*) 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 161a2c8d4e..f11f79bfb9 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 @@ -29,7 +29,7 @@ module Actions # Wildcard expressions (`*`) are supported. # To target all data streams in a cluster, omit this parameter or use `*`. # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. - # Supports comma-separated values, such as `open,hidden`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open,closed. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index 0e1cf95530..38308d813f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -37,7 +37,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: open,closed. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. 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 85322f6e3d..001d29db48 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 @@ -26,7 +26,7 @@ module Actions # Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. # # @option arguments [String, Array] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams (*Required*) - # @option arguments [String, Array] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) + # @option arguments [String, Array] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) Server default: open. # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s. # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb index 231cf83857..832c4f2f01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb @@ -26,7 +26,7 @@ module Actions # Removes the data stream options from a data stream. # # @option arguments [String, Array] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams (*Required*) - # @option arguments [String, Array] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) + # @option arguments [String, Array] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) Server default: open. # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s. # @option arguments [Time] :timeout Explicit timestamp for the document # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 b6366d19c3..b0eefc4bea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb @@ -29,10 +29,9 @@ module Actions # NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. # Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. # The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. # It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb index e561c9ff22..7643b8e64f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb @@ -29,10 +29,9 @@ module Actions # NOTE: Only indices in a time series data stream are supported. # Neither field nor document level security can be defined on the source index. # The source index must be read only (`index.blocks.write: true`). - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :index Name of the time series index to downsample. (*Required*) # @option arguments [String] :target_index Name of the index to create. (*Required*) 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 9b104710c4..77b0286c06 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -32,7 +32,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: all. # @option arguments [Boolean] :ignore_unavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. 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 74e7b90376..eb4a9a6458 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 @@ -28,10 +28,9 @@ module Actions # A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. # The response body reports the per-shard usage count of the data structures that back the fields in the index. # A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*Required*) # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. @@ -39,7 +38,7 @@ module Actions # For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response. # @option arguments [String, Array] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index 3355b76ab3..d125b45372 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -65,7 +65,7 @@ module Actions # # @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @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, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic) 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 364dfe4bc7..ae383b9122 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -35,7 +35,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: all. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. 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 22902d7795..b63957872d 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 @@ -25,7 +25,7 @@ module Actions # Get index templates. # Get information about one or more index templates. # - # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + # @option arguments [String] :name Name of index template to retrieve. Wildcard (*) expressions are supported. # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. # @option arguments [Boolean] :flat_settings If true, returns settings in flat format. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb index 92c3be8db1..20c4a199a5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb @@ -24,10 +24,9 @@ module Indices module Actions # Get the migration reindexing status. # Get the status of a migration reindex attempt for a data stream or index. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :index The index or data stream name. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb index 5ba5dc5b9d..1fe78c2fba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb @@ -26,10 +26,9 @@ module Actions # Reindex all legacy backing indices for a data stream. # This operation occurs in a persistent task. # The persistent task ID is returned immediately and the reindexing work is completed in that 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index 8f81debf9c..5d57c98cf5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -49,7 +49,7 @@ module Actions # This behavior applies even if the request targets other open indices. Server default: true. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. Server default: open. + # Supports comma-separated values, such as `open,hidden`. Server default: closed. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. 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 86667f0a8e..ec3423d6a2 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 @@ -36,7 +36,7 @@ module Actions # # @option arguments [String, Array] :index A comma-separated list of index names to reload analyzers for (*Required*) # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [String] :resource Changed resource to reload analyzers from if applicable # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index 187e81da8d..fa31a2e34a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -36,7 +36,7 @@ module Actions # @option arguments [String, Array] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. # @option arguments [String, Array] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument # determines whether wildcard expressions match hidden data streams. Supports comma-separated values, - # such as `open,hidden`. + # such as `open,hidden`. Server default: open. # @option arguments [String, Array] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics. # @option arguments [String, Array] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. # @option arguments [Boolean] :forbid_closed_indices If true, statistics are not collected from closed indices. Server default: true. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb index a9c571695b..938012994e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform chat completion inference + # Perform chat completion inference. # The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. # It only works with the `chat_completion` task type for `openai` and `elastic` inference services. # NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb index 0475c49ab6..e6757c1e46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform completion inference on the service + # Perform completion inference on the service. # # @option arguments [String] :inference_id The inference Id (*Required*) # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb index f12cd80917..e4686371a5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Delete an inference endpoint + # Delete an inference endpoint. # # @option arguments [String] :task_type The task type # @option arguments [String] :inference_id The inference identifier. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb index 5c522fda3a..00b450457a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Get an inference endpoint + # Get an inference endpoint. # # @option arguments [String] :task_type The task type # @option arguments [String] :inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb index 8f65a97c47..f9835c772c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform reranking inference on the service + # Perform reranking inference on the service. # # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*) # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb index dd823864e3..5ce497607e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform sparse embedding inference on the service + # Perform sparse embedding inference on the service. # # @option arguments [String] :inference_id The inference Id (*Required*) # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb index 7a81cca33c..5eee65a404 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform text embedding inference on the service + # Perform text embedding inference on the service. # # @option arguments [String] :inference_id The inference Id (*Required*) # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index 2407f2fbd6..37dcf9d94b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -44,7 +44,7 @@ module Actions # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases to search. # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. # @option arguments [Boolean] :ccs_minimize_roundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. Server default: true. - # @option arguments [String, Array] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + # @option arguments [String, Array] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Server default: open. # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen. # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes 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 0b41dbc5fb..b5dc5698c3 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 @@ -24,10 +24,9 @@ module Nodes module Actions # Clear the archived repositories metering. # Clear the archived repositories metering information in the cluster. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*) # @option arguments [Integer] :max_archive_version Specifies the maximum `archive_version` to be cleared from the archive. (*Required*) 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 37d412db5e..a366932367 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 @@ -26,10 +26,9 @@ module Actions # Get repositories metering information for a cluster. # This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. # Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index eeec317a6d..ea0f23e8b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -28,7 +28,7 @@ module Actions # Wildcard (`*`) expressions are supported. # To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true. - # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response. # @option arguments [String] :search_type Search operation type # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb index dc45aa8df9..25b915304a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [String] :task_id The task identifier, which can be found by using the tasks API. (*Required*) # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. - # It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. + # It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response 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 e23ff0246c..f34b09d720 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb @@ -27,10 +27,9 @@ module Actions # This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster. # The API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is. # Each context requires a script, but additional parameters depend on the context you're using for that 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. 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 fff6f169f9..ad7d992cd2 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 @@ -24,10 +24,9 @@ module SearchApplication module Actions # Delete a behavioral analytics collection. # The associated data stream is also deleted. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :name The name of the analytics collection to be deleted (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 94a264d918..dddeb17078 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 @@ -23,10 +23,9 @@ module API module SearchApplication module Actions # 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Array] :name A list of analytics collections to limit the returned information # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 6d009064d2..d75d08671e 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 @@ -23,10 +23,9 @@ module API module SearchApplication module Actions # 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :collection_name The name of the behavioral analytics collection. (*Required*) # @option arguments [String] :event_type The analytics event type. (*Required*) 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 bb78b327f8..c0266eed66 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 @@ -23,10 +23,9 @@ module API module SearchApplication module Actions # 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :name The name of the analytics collection to be created or updated. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors 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 97825b6d04..0c7839a601 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 @@ -27,10 +27,9 @@ module Actions # If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. # The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. # You must have `read` privileges on the backing alias of the 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :name The name of the search application to render teh query for. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index 57bf0477d8..ddb56bbaab 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips are minimized for cross-cluster search requests. # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # Supports comma-separated values, such as `open,hidden`. + # Supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Boolean] :explain If `true`, the response includes additional details about score computation as part of a hit. # @option arguments [Boolean] :ignore_throttled If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. Server default: true. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. 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 09591389a1..ff83dbab44 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 @@ -24,10 +24,9 @@ module SearchableSnapshots module Actions # Get cache statistics. # Get statistics about the shared cache for partially mounted indices. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :node_id The names of the nodes in the cluster to target. # @option arguments [Time] :master_timeout [TODO] 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 45ddcad6bf..ff9813efe0 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 @@ -24,14 +24,13 @@ module SearchableSnapshots module Actions # Clear the cache. # Clear indices and data streams from the shared cache for partially mounted indices. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to clear from the cache. # It supports wildcards (`*`). - # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. # @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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb index 87eb3dd92a..958465e89b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb @@ -35,10 +35,9 @@ module Actions # By default, the pipeline definitions that are currently in the system are used. # However, you can supply substitute pipeline definitions in the body of the request. # These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :index The index to simulate ingesting into. # This value can be overridden by specifying an index on each document. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb index 742679a82f..f9ab8ca7af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb @@ -48,10 +48,9 @@ module Actions # For large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API. # The response exposes implementation details of the analysis which may change from version to version. # The response body format is therefore not considered stable and may be different in newer versions. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :repository The name of the snapshot repository. (*Required*) # @option arguments [Integer] :blob_thread_pool_concurrency If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once. Server default: 1. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb index ebac898c29..e4dc0279e4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb @@ -24,10 +24,9 @@ module Streams module Actions # Disable logs stream. # Turn off the logs stream feature for this cluster. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb index 569560de97..6876bded7f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb @@ -27,10 +27,9 @@ module Actions # NOTE: To protect existing data, this feature can be turned on only if the # cluster does not have existing indices or data streams that match the pattern `logs|logs.*`. # If those indices or data streams exist, a `409 - Conflict` response and error is returned. - # 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb index 2783e78d52..2662902357 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb @@ -24,10 +24,9 @@ module Streams module Actions # Get the status of streams. # Get the current status for all types of 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. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb index 68916f8cf9..35c01903d9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb @@ -31,10 +31,9 @@ module Actions # The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. # To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. # You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :task_id The task identifier. # @option arguments [String, Array] :actions A comma-separated list or wildcard expression of actions that is used to limit the request. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb index 70c1d854b6..913c518b0d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb @@ -27,10 +27,9 @@ module Actions # WARNING: The task management API is new and should still be considered a beta feature. # The API may change in ways that are not backwards compatible. # If the task identifier is not found, a 404 response code indicates that there are no resources that match the 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String] :task_id The task identifier. (*Required*) # @option arguments [Time] :timeout The period to wait for a response. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb index 8bcc07372b..cb482f191c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb @@ -78,10 +78,9 @@ module Actions # In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header. # The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request. # The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST 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 - # support SLA of official GA features. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [String, Array] :actions A comma-separated list or wildcard expression of actions used to limit the request. # For example, you can use `cluser:*` to retrieve all cluster-related tasks. 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 b612b2a62a..f322b25897 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -109,7 +109,7 @@ module Actions # This parameter can be used only when the `q` query string parameter is specified. # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - # It supports comma-separated values, such as `open,hidden`. + # It supports comma-separated values, such as `open,hidden`. Server default: open. # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0. # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. 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 3fecbde8af..3017d27547 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 @@ -27,7 +27,7 @@ module Actions # # @option arguments [String] :task_id The ID for the task. (*Required*) # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. - # To turn off throttling, set it to `-1`. Server default: -1. + # To turn off throttling, set it to `-1`. (*Required*) # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index d8b4c1dc56..fb4c21ed33 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -18,6 +18,6 @@ module Elasticsearch module API VERSION = '9.1.3'.freeze - ES_SPECIFICATION_COMMIT = 'ab308fbed818e33443a905ef54a3e2ee7333c11a'.freeze + ES_SPECIFICATION_COMMIT = 'faf5d46d7276ac2068ec0cf130fde1126bebacf9'.freeze end end