Skip to content

Commit 79cce77

Browse files
committed
[API] Adds include_defaults (Boolean) parameter
Return all default configurations (default: false) APIs: - cluster.get_component_template - indices.get_data_stream - indices.get_index_template - indices.simulate_index_template - indices.simulate_template
1 parent 7ad4397 commit 79cce77

File tree

5 files changed

+5
-0
lines changed

5 files changed

+5
-0
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ module Actions
2727
# @option arguments [List] :name The comma separated names of the component templates
2828
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
2929
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
30+
# @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false)
3031
# @option arguments [Hash] :headers Custom HTTP headers
3132
#
3233
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html

elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ module Actions
2626
#
2727
# @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams
2828
# @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
29+
# @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false)
2930
# @option arguments [Hash] :headers Custom HTTP headers
3031
#
3132
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html

elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ module Actions
2828
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
2929
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
3030
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
31+
# @option arguments [Boolean] :include_defaults Return all relevant default configurations for the index template (default: false)
3132
# @option arguments [Hash] :headers Custom HTTP headers
3233
#
3334
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html

elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ module Actions
2828
# @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
2929
# @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
3030
# @option arguments [Time] :master_timeout Specify timeout for connection to master
31+
# @option arguments [Boolean] :include_defaults Return all relevant default configurations for this index template simulation (default: false)
3132
# @option arguments [Hash] :headers Custom HTTP headers
3233
# @option arguments [Hash] :body New index template definition, which will be included in the simulation, as if it already exists in the system
3334
#

elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ module Actions
2828
# @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
2929
# @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
3030
# @option arguments [Time] :master_timeout Specify timeout for connection to master
31+
# @option arguments [Boolean] :include_defaults Return all relevant default configurations for this template simulation (default: false)
3132
# @option arguments [Hash] :headers Custom HTTP headers
3233
# @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified
3334
#

0 commit comments

Comments
 (0)