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

elasticsearch-api 9.0.2 → 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 (518) hide show

data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb CHANGED Viewed

@@ -30,6 +30,17 @@ module Elasticsearch
         # 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
+        #  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-connector-update-filtering
@@ -53,7 +64,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_filtering/_activate"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module Elasticsearch
     module Connector
       module Actions
         # Update the connector API key ID.
-        # Update the +api_key_id+ and +api_key_secret_id+ fields of a connector.
+        # Update the `api_key_id` and `api_key_secret_id` fields of a connector.
         # You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.
         # The connector secret ID is required only for Elastic managed (native) connectors.
         # Self-managed connectors (connector clients) do not use this field.
@@ -33,6 +33,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -58,7 +69,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_api_key_id"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_configuration.rb CHANGED Viewed

@@ -30,6 +30,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_configuration"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_error.rb CHANGED Viewed

@@ -32,6 +32,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -57,7 +68,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_error"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_features.rb CHANGED Viewed

@@ -39,6 +39,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -64,7 +75,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_features"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_filtering.rb CHANGED Viewed

@@ -32,6 +32,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -57,7 +68,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_filtering"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb CHANGED Viewed

@@ -30,6 +30,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_filtering/_validation"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_index_name.rb CHANGED Viewed

@@ -23,13 +23,24 @@ module Elasticsearch
     module Connector
       module Actions
         # Update the connector index name.
-        # Update the +index_name+ field of a connector, specifying the index where the data ingested by the connector is stored.
+        # Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support
         # SLA of official GA features.
         #
         # @option arguments [String] :connector_id The unique identifier of the connector to be updated (*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<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
         #
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_index_name"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_name.rb CHANGED Viewed

@@ -29,6 +29,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -54,7 +65,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_name"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_native.rb CHANGED Viewed

@@ -29,6 +29,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -54,7 +65,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_native"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_pipeline.rb CHANGED Viewed

@@ -30,6 +30,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_pipeline"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_scheduling.rb CHANGED Viewed

@@ -29,6 +29,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -54,7 +65,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_scheduling"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_service_type.rb CHANGED Viewed

@@ -29,6 +29,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -54,7 +65,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_service_type"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/connector/update_status.rb CHANGED Viewed

@@ -29,6 +29,17 @@ module Elasticsearch
         # 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
+        #  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
         #
@@ -54,7 +65,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = "_connector/#{Utils.listify(_connector_id)}/_status"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -24,34 +24,34 @@ module Elasticsearch
       # Count search results.
       # Get the number of documents matching a query.
       # The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.
-      # The query is optional. When no query is provided, the API uses +match_all+ to count all the documents.
+      # The query is optional. When no query is provided, the API uses `match_all` to count all the documents.
       # The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.
       # The operation is broadcast across all shards.
       # For each shard ID group, a replica is chosen and the search is run against it.
       # This means that replicas increase the scalability of the count.
       #
       # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search.
-      #  It supports wildcards (+*+).
-      #  To search 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.
+      #  It supports wildcards (`*`).
+      #  To search 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.
+      #  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] :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 a default when no field prefix is given in the query string.
-      #  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 [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.
-      #  It supports comma-separated values, such as +open,hidden+. Server default: open.
-      # @option arguments [Boolean] :ignore_throttled If +true+, concrete, expanded, or aliased indices are ignored when frozen. Server default: true.
-      # @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.
-      #  This parameter can be used only when the +q+ query string parameter is specified.
-      # @option arguments [Float] :min_score The minimum +_score+ value that documents must have to be included in the result.
+      #  It supports comma-separated values, such as `open,hidden`. Server default: open.
+      # @option arguments [Boolean] :ignore_throttled If `true`, concrete, expanded, or aliased indices are ignored when frozen. Server default: true.
+      # @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.
+      #  This parameter can be used only when the `q` query string parameter is specified.
+      # @option arguments [Float] :min_score The minimum `_score` value that documents must have to be included in the result.
       # @option arguments [String] :preference The node or shard the operation should be performed on.
       #  By default, it is random.
       # @option arguments [String] :routing A custom value used to route operations to a specific shard.
@@ -62,6 +62,17 @@ module Elasticsearch
       #  When possible, let Elasticsearch perform early termination automatically.
       #  Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
       # @option arguments [String] :q The query in Lucene query string syntax. This parameter cannot be used with a request body.
+      # @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/create.rb CHANGED Viewed

@@ -22,78 +22,70 @@ module Elasticsearch
   module API
     module Actions
       # Create a new document in the index.
-      # You can index a new JSON document with the +/<target>/_doc/+ or +/<target>/_create/<_id>+ APIs
-      # Using +_create+ guarantees that the document is indexed only if it does not already exist.
+      # You can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs
+      # Using `_create` guarantees that the document is indexed only if it does not already exist.
       # It returns a 409 response when a document with a same ID already exists in the index.
-      # To update an existing document, you must use the +/<target>/_doc/+ API.
+      # To update an existing document, you must use the `/<target>/_doc/` API.
       # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
-      # * To add a document using the +PUT /<target>/_create/<_id>+ or +POST /<target>/_create/<_id>+ request formats, you must have the +create_doc+, +create+, +index+, or +write+ index privilege.
-      # * To automatically create a data stream or index with this API request, you must have the +auto_configure+, +create_index+, or +manage+ index privilege.
+      # * To add a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.
+      # * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.
       # Automatic data stream creation requires a matching index template with data stream enabled.
       # **Automatically create data streams and indices**
-      # If the request's target doesn't exist and matches an index template with a +data_stream+ definition, the index operation automatically creates the data stream.
+      # If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.
       # If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.
       # NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.
       # If no mapping exists, the index operation creates a dynamic mapping.
       # By default, new fields and objects are automatically added to the mapping if needed.
-      # Automatic index creation is controlled by the +action.auto_create_index+ setting.
-      # If it is +true+, any index can be created automatically.
-      # You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to +false+ to turn off automatic index creation entirely.
-      # Specify a comma-separated list of patterns you want to allow or prefix each pattern with +++ or +-+ to indicate whether it should be allowed or blocked.
+      # Automatic index creation is controlled by the `action.auto_create_index` setting.
+      # If it is `true`, any index can be created automatically.
+      # You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.
+      # Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.
       # When a list is specified, the default behaviour is to disallow.
-      # NOTE: The +action.auto_create_index+ setting affects the automatic creation of indices only.
+      # NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.
       # It does not affect the creation of data streams.
       # **Routing**
       # By default, shard placement — or routing — is controlled by using a hash of the document's ID value.
-      # For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the +routing+ parameter.
-      # When setting up explicit mapping, you can also use the +_routing+ field to direct the index operation to extract the routing value from the document itself.
+      # For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.
+      # When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.
       # This does come at the (very minimal) cost of an additional document parsing pass.
-      # If the +_routing+ mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.
-      # NOTE: Data streams do not support custom routing unless they were created with the +allow_custom_routing+ setting enabled in the template.
+      # If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.
+      # NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.
       # **Distributed**
       # The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.
       # After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.
       # **Active shards**
       # To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.
       # If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.
-      # By default, write operations only wait for the primary shards to be active before proceeding (that is to say +wait_for_active_shards+ is +1+).
-      # This default can be overridden in the index settings dynamically by setting +index.write.wait_for_active_shards+.
-      # To alter this behavior per operation, use the +wait_for_active_shards request+ parameter.
-      # Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is +number_of_replicas++1).
+      # By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).
+      # This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.
+      # To alter this behavior per operation, use the `wait_for_active_shards request` parameter.
+      # Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).
       # Specifying a negative value or a number greater than the number of shard copies will throw an error.
       # For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).
       # If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.
       # This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.
-      # If +wait_for_active_shards+ is set on the request to +3+ (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.
+      # If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.
       # This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.
-      # However, if you set +wait_for_active_shards+ to +all+ (or to +4+, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.
+      # However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.
       # The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.
       # It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.
       # After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.
-      # The +_shards+ section of the API response reveals the number of shard copies on which replication succeeded and failed.
+      # The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.
       #
       # @option arguments [String] :id A unique identifier for the document.
-      #  To automatically generate a document ID, use the +POST /<target>/_doc/+ request format. (*Required*)
+      #  To automatically generate a document ID, use the `POST /<target>/_doc/` request format. (*Required*)
       # @option arguments [String] :index The name of the data stream or index to target.
-      #  If the target doesn't exist and matches the name or wildcard (+*+) pattern of an index template with a +data_stream+ definition, this request creates the data stream.
+      #  If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.
       #  If the target doesn't exist and doesn’t match a data stream template, this request creates the index. (*Required*)
-      # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
-      # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
       # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
-      # @option arguments [String] :op_type Set to +create+ to only index the document if it does not already exist (put if absent).
-      #  If a document with the specified +_id+ already exists, the indexing operation will fail.
-      #  The behavior is the same as using the +<index>/_create+ endpoint.
-      #  If a document ID is specified, this paramater defaults to +index+.
-      #  Otherwise, it defaults to +create+.
-      #  If the request targets a data stream, an +op_type+ of +create+ is required.
       # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents.
-      #  If the index has a default ingest pipeline specified, setting the value to +_none+ turns off the default ingest pipeline for this request.
+      #  If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.
       #  If a final pipeline is configured, it will always run regardless of the value of this parameter.
-      # @option arguments [String] :refresh If +true+, Elasticsearch refreshes the affected shards to make this operation visible to search.
-      #  If +wait_for+, it waits for a refresh to make this operation visible to search.
-      #  If +false+, it does nothing with refreshes. Server default: false.
-      # @option arguments [Boolean] :require_alias If +true+, the destination must be an index alias.
-      # @option arguments [Boolean] :require_data_stream If +true+, the request's actions must target a data stream (existing or to be created).
+      # @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.
+      #  If `wait_for`, it waits for a refresh to make this operation visible to search.
+      #  If `false`, it does nothing with refreshes. Server default: false.
+      # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias.
+      # @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created).
       # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
       # @option arguments [Time] :timeout The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
       #  Elasticsearch waits for at least the specified timeout period before failing.
@@ -105,8 +97,19 @@ module Elasticsearch
       #  It must be a non-negative long number.
       # @option arguments [String] :version_type The version type.
       # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
-      #  You can set it to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+).
-      #  The default value of +1+ means it waits for each primary shard to be active. Server default: 1.
+      #  You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
+      #  The default value of `1` means it waits for each primary shard to be active. Server default: 1.
+      # @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 document
       #