RubyGems - elasticsearch-api - Versions diffs - 9.0.3 → 9.0.4 - Mend

elasticsearch-api 9.0.3 → 9.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (517) hide show

data/lib/elasticsearch/api/actions/exists.rb CHANGED Viewed

@@ -23,44 +23,57 @@ module Elasticsearch
     module Actions
       # Check a document.
       # Verify that a document exists.
-      # For example, check to see if a document with the +_id+ 0 exists:
-      # +
+      # For example, check to see if a document with the `_id` 0 exists:
+      #
+      # ```
       # HEAD my-index-000001/_doc/0
-      # +
-      # If the document exists, the API returns a status code of +200 - OK+.
-      # If the document doesn’t exist, the API returns +404 - Not Found+.
+      # ```
+      #
+      # If the document exists, the API returns a status code of `200 - OK`.
+      # If the document doesn’t exist, the API returns `404 - Not Found`.
       # **Versioning support**
-      # You can use the +version+ parameter to check the document only if its current version is equal to the specified one.
+      # You can use the `version` parameter to check the document only if its current version is equal to the specified one.
       # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document.
       # The old version of the document doesn't disappear immediately, although you won't be able to access it.
       # Elasticsearch cleans up deleted documents in the background as you continue to index more data.
       #
       # @option arguments [String] :id A unique document identifier. (*Required*)
       # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases.
-      #  It supports wildcards (+*+). (*Required*)
+      #  It supports wildcards (`*`). (*Required*)
       # @option arguments [String] :preference The node or shard the operation should be performed on.
-      #  By default, the operation is randomized between the shard replicas.If it is set to +_local+, the operation will prefer to be run on a local allocated shard when possible.
+      #  By default, the operation is randomized between the shard replicas.If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.
       #  If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.
       #  This can help with "jumping values" when hitting different shards in different refresh states.
       #  A sample value can be something like the web session ID or the user name.
-      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
-      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
       # @option arguments [String] :routing A custom value used to route operations to a specific shard.
-      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
-      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       #  If this parameter is specified, only these source fields are returned.
-      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can exclude fields from this subset using the `_source_excludes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
       #  If no fields are specified, no stored fields are included in the response.
-      #  If this field is specified, the +_source+ parameter defaults to +false+.
+      #  If this field is specified, the `_source` parameter defaults to `false`.
       # @option arguments [Integer] :version Explicit version number for concurrency control.
       #  The specified version must match the current version of the document for the request to succeed.
       # @option arguments [String] :version_type The version type.
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get

data/lib/elasticsearch/api/actions/exists_source.rb CHANGED Viewed

@@ -24,26 +24,39 @@ module Elasticsearch
       # Check for a document source.
       # Check whether a document source exists in an index.
       # For example:
-      # +
+      #
+      # ```
       # HEAD my-index-000001/_source/1
-      # +
+      # ```
+      #
       # A document's source is not available if it is disabled in the mapping.
       #
       # @option arguments [String] :id A unique identifier for the document. (*Required*)
       # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases.
-      #  It supports wildcards (+*+). (*Required*)
+      #  It supports wildcards (`*`). (*Required*)
       # @option arguments [String] :preference The node or shard the operation should be performed on.
       #  By default, the operation is randomized between the shard replicas.
-      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
-      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
       # @option arguments [String] :routing A custom value used to route operations to a specific shard.
-      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       # @option arguments [Integer] :version The version number for concurrency control.
       #  It must match the current version of the document for the request to succeed.
       # @option arguments [String] :version_type The version type.
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get

data/lib/elasticsearch/api/actions/explain.rb CHANGED Viewed

@@ -29,28 +29,39 @@ module Elasticsearch
       # @option arguments [String] :index Index names that are used to limit the request.
       #  Only a single index name can be provided to this parameter. (*Required*)
       # @option arguments [String] :analyzer The analyzer to use for the query string.
-      #  This parameter can be used only when the +q+ query string parameter is specified.
-      # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
-      #  This parameter can be used only when the +q+ query string parameter is specified.
-      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+.
-      #  This parameter can be used only when the +q+ query string parameter is specified. Server default: OR.
+      #  This parameter can be used only when the `q` query string parameter is specified.
+      # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
+      #  This parameter can be used only when the `q` query string parameter is specified.
+      # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`.
+      #  This parameter can be used only when the `q` query string parameter is specified. Server default: OR.
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
-      #  This parameter can be used only when the +q+ query string parameter is specified.
-      # @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.
-      #  This parameter can be used only when the +q+ query string parameter is specified.
+      #  This parameter can be used only when the `q` query string parameter is specified.
+      # @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.
+      #  This parameter can be used only when the `q` query string parameter is specified.
       # @option arguments [String] :preference The node or shard the operation should be performed on.
       #  It is random by default.
       # @option arguments [String] :routing A custom value used to route operations to a specific shard.
-      # @option arguments [Boolean, String, Array<String>] :_source +True+ or +false+ to return the +_source+ field or not or a list of fields to return.
+      # @option arguments [Boolean, String, Array<String>] :_source `True` or `false` to return the `_source` field or not or a list of fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
-      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       #  If this parameter is specified, only these source fields are returned.
-      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can exclude fields from this subset using the `_source_excludes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return in the response.
       # @option arguments [String] :q The query in the Lucene query string syntax.
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #

data/lib/elasticsearch/api/actions/features/get_features.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module Elasticsearch
     module Features
       module Actions
         # Get the features.
-        # Get a list of features that can be included in snapshots using the +feature_states+ field when creating a snapshot.
+        # Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.
         # You can use this API to determine which feature states to include when taking a snapshot.
         # By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.
         # A feature state includes one or more system indices necessary for a given feature to function.
@@ -32,6 +32,17 @@ module Elasticsearch
         # In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.
         #
         # @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
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-features-get-features

data/lib/elasticsearch/api/actions/features/reset_features.rb CHANGED Viewed

@@ -39,6 +39,17 @@ module Elasticsearch
         # 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
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-features-reset-features

data/lib/elasticsearch/api/actions/field_caps.rb CHANGED Viewed

@@ -25,21 +25,32 @@ module Elasticsearch
       # Get information about the capabilities of fields among multiple indices.
       # For data streams, the API returns field capabilities among the stream’s backing indices.
       # It returns runtime fields like any other field.
-      # For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the +keyword+ family.
+      # For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.
       #
       # @option arguments [String, Array] :index A 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 [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<String>] :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+. Server default: open.
-      # @option arguments [String, Array<String>] :fields A comma-separated list of fields to retrieve capabilities for. Wildcard (+*+) expressions are supported.
-      # @option arguments [Boolean] :ignore_unavailable If +true+, missing or closed indices are not included in the response.
+      #  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<String>] :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`. Server default: open.
+      # @option arguments [String, Array<String>] :fields A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.
+      # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
       # @option arguments [Boolean] :include_unmapped If true, unmapped fields are included in the response.
       # @option arguments [String] :filters A comma-separated list of filters to apply to the response.
       # @option arguments [Array<String>] :types A comma-separated list of field types to include.
       #  Any fields that do not match one of these types will be excluded from the results.
       #  It defaults to empty, meaning that all field types are returned.
       # @option arguments [Boolean] :include_empty_fields If false, empty fields are not included in the response. Server default: true.
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #

data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb CHANGED Viewed

@@ -26,15 +26,26 @@ module Elasticsearch
         # Get the current global checkpoints for an index.
         # This API is designed for internal use by the Fleet server project.
         #
-        # @option arguments [Indexname, Indexalias] :index A single index or index alias that resolves to a single index. (*Required*)
+        # @option arguments [String] :index A single index or index alias that resolves to a single index. (*Required*)
         # @option arguments [Boolean] :wait_for_advance A boolean value which controls whether to wait (until the timeout) for the global checkpoints
-        #  to advance past the provided +checkpoints+.
+        #  to advance past the provided `checkpoints`.
         # @option arguments [Boolean] :wait_for_index A boolean value which controls whether to wait (until the timeout) for the target index to exist
-        #  and all primary shards be active. Can only be true when +wait_for_advance+ is true.
-        # @option arguments [Array<Integer>] :checkpoints A comma separated list of previous global checkpoints. When used in combination with +wait_for_advance+,
+        #  and all primary shards be active. Can only be true when `wait_for_advance` is true.
+        # @option arguments [Array<Integer>] :checkpoints A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`,
         #  the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list
         #  will cause Elasticsearch to immediately return the current global checkpoints. Server default: [].
-        # @option arguments [Time] :timeout Period to wait for a global checkpoints to advance past +checkpoints+. Server default: 30s.
+        # @option arguments [Time] :timeout Period to wait for a global checkpoints to advance past `checkpoints`. Server default: 30s.
+        # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-fleet

data/lib/elasticsearch/api/actions/fleet/msearch.rb CHANGED Viewed

@@ -25,13 +25,13 @@ module Elasticsearch
         # Run multiple Fleet searches.
         # 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.
+        # 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.
         #
-        # @option arguments [Indexname, Indexalias] :index A single target to search. If the target is an index alias, it must resolve to a single index.
+        # @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.
         # @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<String>] :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.
@@ -48,7 +48,18 @@ module Elasticsearch
         #  Elasticsearch to immediately execute the search. Server default: [].
         # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or shard failures.
         #  If false, returns an error with no partial results.
-        #  Defaults to the configured cluster setting +search.default_allow_partial_results+, which is true by default.
+        #  Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.
+        # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body searches
         #

data/lib/elasticsearch/api/actions/fleet/search.rb CHANGED Viewed

@@ -30,7 +30,7 @@ module Elasticsearch
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @option arguments [Indexname, Indexalias] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*)
+        # @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]
         # @option arguments [String] :analyzer [TODO]
         # @option arguments [Boolean] :analyze_wildcard [TODO]
@@ -71,13 +71,24 @@ module Elasticsearch
         # @option arguments [String] :q [TODO]
         # @option arguments [Integer] :size [TODO]
         # @option arguments [Integer] :from [TODO]
-        # @option arguments [String] :sort [TODO]
+        # @option arguments [String, Array<String>] :sort [TODO]
         # @option arguments [Array<Integer>] :wait_for_checkpoints A comma separated list of checkpoints. When configured, the search API will only be executed on a shard
         #  after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause
         #  Elasticsearch to immediately execute the search. Server default: [].
         # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or shard failures.
         #  If false, returns an error with no partial results.
-        #  Defaults to the configured cluster setting +search.default_allow_partial_results+, which is true by default.
+        #  Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.
+        # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/get.rb CHANGED Viewed

@@ -24,31 +24,39 @@ module Elasticsearch
       # Get a document by its ID.
       # Get a document and its source or stored fields from an index.
       # By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).
-      # In the case where stored fields are requested with the +stored_fields+ parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.
-      # To turn off realtime behavior, set the +realtime+ parameter to false.
+      # In the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.
+      # To turn off realtime behavior, set the `realtime` parameter to false.
       # **Source filtering**
-      # By default, the API returns the contents of the +_source+ field unless you have used the +stored_fields+ parameter or the +_source+ field is turned off.
-      # You can turn off +_source+ retrieval by using the +_source+ parameter:
-      # +
+      # By default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.
+      # You can turn off `_source` retrieval by using the `_source` parameter:
+      #
+      # ```
       # GET my-index-000001/_doc/0?_source=false
-      # +
-      # If you only need one or two fields from the +_source+, use the +_source_includes+ or +_source_excludes+ parameters to include or filter out particular fields.
+      # ```
+      #
+      # If you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.
       # This can be helpful with large documents where partial retrieval can save on network overhead
       # Both parameters take a comma separated list of fields or wildcard expressions.
       # For example:
-      # +
+      #
+      # ```
       # GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities
-      # +
+      # ```
+      #
       # If you only want to specify includes, you can use a shorter notation:
-      # +
+      #
+      # ```
       # GET my-index-000001/_doc/0?_source=*.id
-      # +
+      # ```
+      #
       # **Routing**
       # If routing is used during indexing, the routing value also needs to be specified to retrieve a document.
       # For example:
-      # +
+      #
+      # ```
       # GET my-index-000001/_doc/2?routing=user1
-      # +
+      # ```
+      #
       # This request gets the document with ID 2, but it is routed based on the user.
       # The document is not fetched if the correct routing is not specified.
       # **Distributed**
@@ -57,41 +65,52 @@ module Elasticsearch
       # The replicas are the primary shard and its replicas within that shard ID group.
       # This means that the more replicas you have, the better your GET scaling will be.
       # **Versioning support**
-      # You can use the +version+ parameter to retrieve the document only if its current version is equal to the specified one.
+      # You can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.
       # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document.
       # The old version of the document doesn't disappear immediately, although you won't be able to access it.
       # Elasticsearch cleans up deleted documents in the background as you continue to index more data.
       #
       # @option arguments [String] :id A unique document identifier. (*Required*)
       # @option arguments [String] :index The name of the index that contains the document. (*Required*)
-      # @option arguments [Boolean] :force_synthetic_source Indicates whether the request forces synthetic +_source+.
-      #  Use this paramater to test if the mapping supports synthetic +_source+ and to get a sense of the worst case performance.
+      # @option arguments [Boolean] :force_synthetic_source Indicates whether the request forces synthetic `_source`.
+      #  Use this parameter to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance.
       #  Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index.
       # @option arguments [String] :preference The node or shard the operation should be performed on.
-      #  By default, the operation is randomized between the shard replicas.If it is set to +_local+, the operation will prefer to be run on a local allocated shard when possible.
+      #  By default, the operation is randomized between the shard replicas.If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.
       #  If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.
       #  This can help with "jumping values" when hitting different shards in different refresh states.
       #  A sample value can be something like the web session ID or the user name.
-      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
-      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
       # @option arguments [String] :routing A custom value used to route operations to a specific shard.
-      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
-      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
       #  If this parameter is specified, only these source fields are returned.
-      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
-      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      #  You can exclude fields from this subset using the `_source_excludes` query parameter.
+      #  If the `_source` parameter is `false`, this parameter is ignored.
       # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
       #  If no fields are specified, no stored fields are included in the response.
-      #  If this field is specified, the +_source+ parameter defaults to +false+.
-      #  Only leaf fields can be retrieved with the +stored_field+ option.
-      #  Object fields can't be returned;if specified, the request fails.
+      #  If this field is specified, the `_source` parameter defaults to `false`.
+      #  Only leaf fields can be retrieved with the `stored_fields` option.
+      #  Object fields can't be returned; if specified, the request fails.
       # @option arguments [Integer] :version The version number for concurrency control.
       #  It must match the current version of the document for the request to succeed.
       # @option arguments [String] :version_type The version type.
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get

data/lib/elasticsearch/api/actions/get_script.rb CHANGED Viewed

@@ -27,7 +27,18 @@ module Elasticsearch
       # @option arguments [String] :id The identifier for the stored script or search template. (*Required*)
       # @option arguments [Time] :master_timeout The period to wait for the master node.
       #  If the master node is not available before the timeout expires, the request fails and returns an error.
-      #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: .
+      #  It can also be set to `-1` to indicate that the request should never timeout. Server default: .
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script

data/lib/elasticsearch/api/actions/get_script_context.rb CHANGED Viewed

@@ -24,6 +24,17 @@ module Elasticsearch
       # Get script contexts.
       # Get a list of supported script contexts and their methods.
       #
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script-context
@@ -38,7 +49,7 @@ module Elasticsearch
         method = Elasticsearch::API::HTTP_GET
         path   = '_script_context'
-        params = {}
+        params = Utils.process_params(arguments)
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/get_script_languages.rb CHANGED Viewed

@@ -24,6 +24,17 @@ module Elasticsearch
       # Get script languages.
       # Get a list of available script types, languages, and contexts.
       #
+      # @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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script-languages
@@ -38,7 +49,7 @@ module Elasticsearch
         method = Elasticsearch::API::HTTP_GET
         path   = '_script_language'
-        params = {}
+        params = Utils.process_params(arguments)
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, body, headers, request_opts)