Skip to content

Commit 5b16656

Browse files
committed
[API] Adds include_source_on_error parameter: True or false if to
include the document source in the error message in case of parsing errors. Defaults to true. APIs affected: bulk, create, index, update
1 parent 47f7a2d commit 5b16656

File tree

6 files changed

+6
-1
lines changed

6 files changed

+6
-1
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ module Actions
3535
# @option arguments [Boolean] :require_alias If true, the request’s actions must target an index alias. Defaults to false.
3636
# @option arguments [Boolean] :require_data_stream If true, the request's actions must target a data stream (existing or to-be-created). Default to false
3737
# @option arguments [Boolean] :list_executed_pipelines Sets list_executed_pipelines for all incoming documents. Defaults to unset (false)
38+
# @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true.
3839
# @option arguments [Hash] :headers Custom HTTP headers
3940
# @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
4041
# or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.

elasticsearch-api/lib/elasticsearch/api/actions/create.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ module Actions
3434
# @option arguments [Number] :version Explicit version number for concurrency control
3535
# @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
3636
# @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
37+
# @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true.
3738
# @option arguments [Hash] :headers Custom HTTP headers
3839
# @option arguments [Hash] :body The document (*Required*)
3940
#

elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# Gets information about an enrich policy.
2626
#
2727
# @option arguments [List] :name A comma-separated list of enrich policy names
28-
# @option arguments [Time] :master_timeout Timeout for processing on master node
28+
# @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked
2929
# @option arguments [Hash] :headers Custom HTTP headers
3030
#
3131
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html

elasticsearch-api/lib/elasticsearch/api/actions/index.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ module Actions
3737
# @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
3838
# @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false
3939
# @option arguments [Boolean] :require_data_stream When true, requires the destination to be a data stream (existing or to-be-created). Default is false
40+
# @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true.
4041
# @option arguments [Hash] :headers Custom HTTP headers
4142
# @option arguments [Hash] :body The document (*Required*)
4243
#

elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ module IndexLifecycleManagement
2424
module Actions
2525
# Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
2626
#
27+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
2728
# @option arguments [Boolean] :dry_run If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false
2829
# @option arguments [Hash] :headers Custom HTTP headers
2930
# @option arguments [Hash] :body Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data")

elasticsearch-api/lib/elasticsearch/api/actions/update.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ module Actions
3737
# @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
3838
# @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
3939
# @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
40+
# @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true.
4041
# @option arguments [Hash] :headers Custom HTTP headers
4142
# @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
4243
#

0 commit comments

Comments
 (0)