[API] Updates source code docs, spec commit 896e37f76add4e8878e9f04205dd8628c7263219

.buildkite/pipeline.yml

@@ -25,7 +25,7 @@ steps:
             transport: main
     env:
       RUBY_VERSION: '{{ matrix.ruby }}'
-      STACK_VERSION: 9.0.2-SNAPSHOT
+      STACK_VERSION: 9.0.3-SNAPSHOT
       ES_YAML_TESTS_BRANCH: '9.0'
       TRANSPORT_VERSION: '{{ matrix.transport }}'
       RUBY_SOURCE: '{{ matrix.ruby_source }}'

.github/workflows/9.0.yml

@@ -26,7 +26,7 @@ jobs:
         sudo sysctl -w vm.max_map_count=262144
     - uses: elastic/elastic-github-actions/elasticsearch@master
       with:
-        stack-version: 9.0.2-SNAPSHOT
+        stack-version: 9.0.3-SNAPSHOT
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -39,4 +39,4 @@ jobs:
     - name: elasticsearch
       run: cd elasticsearch && bundle exec rake test:all
     - name: elasticsearch-api
-      run: rake es:download_artifacts[9.0.2-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all
+      run: rake es:download_artifacts[9.0.3-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all

.github/workflows/otel.yml

@@ -28,7 +28,7 @@ jobs:
           sudo sysctl -w vm.max_map_count=262144
       - uses: elastic/elastic-github-actions/elasticsearch@master
         with:
-          stack-version: 9.0.2-SNAPSHOT
+          stack-version: 9.0.3-SNAPSHOT
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
@@ -41,4 +41,4 @@ jobs:
       - name: elasticsearch
         run: cd elasticsearch && bundle exec rake test:all
       - name: elasticsearch-api
-        run: rake es:download_artifacts[9.0.2-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all
+        run: rake es:download_artifacts[9.0.3-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all

elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb

@@ -33,11 +33,12 @@ module Actions
         # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
         # @option arguments [String] :bytes The unit used to display byte values.
         # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
-        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
+        #  It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
+        # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
-        # @option arguments [String] :time Unit used to display time values.
+        # @option arguments [String] :time The unit used to display time values.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option

elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb

@@ -31,8 +31,9 @@ module Actions
         #  Supports wildcards (`*`).
         #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
         # @option arguments [String] :bytes The unit used to display byte values.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
-        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
+        #  It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
+        # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
         # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the

elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb

@@ -32,11 +32,11 @@ module Actions
         #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
         # @option arguments [String] :bytes The unit used to display byte values.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
-        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
-        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
-        # @option arguments [String] :time Unit used to display time values.
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String] :time The unit used to display time values.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option

elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb

@@ -32,7 +32,8 @@ module Actions
         #  `_all` returns all repositories.
         #  If any repository fails during the request, Elasticsearch returns an error.
         # @option arguments [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
+        #  It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.

elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb

@@ -30,15 +30,15 @@ module Actions
         # @option arguments [String, Array<String>] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request.
         #  Accepts wildcard expressions.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
-        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
         # @option arguments [String] :time The unit used to display time values.
         # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
         #  local cluster state. If `false` the list of selected nodes are computed
         #  from the cluster state of the master node. In both cases the coordinating
         #  node will send requests for further information to each selected node.
-        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option

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

@@ -28,6 +28,7 @@ module Actions
         # @option arguments [String] :name Comma-separated list of component template names used to limit the request.
         #  Wildcard (`*`) expressions are supported.
         # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
+        # @option arguments [String, Array<String>] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
         # @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false)
         # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only.
         #  If `false`, information is retrieved from the master node.

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

@@ -43,6 +43,7 @@ module Actions
         #  If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
         #  If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. (*Required*)
         # @option arguments [Boolean] :create If `true`, this request cannot replace or update existing component templates.
+        # @option arguments [String] :cause User defined reason for create the component template. Server default: api.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -77,15 +77,7 @@ module Actions
       # @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 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 a final pipeline is configured, it will always run regardless of the value of this parameter.

elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb

@@ -27,11 +27,12 @@ module Actions
         # EQL assumes each document in a data stream or index corresponds to an event.
         #
         # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
-        # @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
+        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) Server default: true.
         # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
         # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
         #  This flag has effect only if allow_partial_search_results is true.
-        # @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
+        # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
+        # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true.
         # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
         # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
         # @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.

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

@@ -46,7 +46,6 @@ module Actions
       # @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 [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
       # @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.

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

@@ -138,6 +138,7 @@ module Actions
       #  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] :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 [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

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

@@ -45,6 +45,12 @@ module Actions
         #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
         # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
         # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
+        # @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. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+        #  Supports comma-separated values, such as `open,hidden`. Server default: open.
+        # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
         # @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

elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb

@@ -46,6 +46,7 @@ module Actions
         #
         # @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
         # @option arguments [String] :inference_id The inference Id (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. 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

elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb

@@ -27,6 +27,7 @@ module Actions
         #
         # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
         # @option arguments [String] :alibabacloud_inference_id The unique identifier of the inference endpoint. (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. 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

elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb

@@ -27,6 +27,7 @@ module Actions
         #
         # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
         # @option arguments [String] :amazonbedrock_inference_id The unique identifier of the inference endpoint. (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. 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

elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb

@@ -28,6 +28,7 @@ module Actions
         # @option arguments [String] :task_type The task type.
         #  The only valid task type for the model to perform is `completion`. (*Required*)
         # @option arguments [String] :anthropic_inference_id The unique identifier of the inference endpoint. (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. 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