Skip to content

Commit 8304c3d

Browse files
committed
[DOCS] Updates source code docs to latest spec
1 parent 0854825 commit 8304c3d

File tree

11 files changed

+17
-10
lines changed

11 files changed

+17
-10
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ module Actions
7878
# * JavaScript: Check out `client.helpers.*`
7979
# * .NET: Check out `BulkAllObservable`
8080
# * PHP: Check out bulk indexing.
81+
# * Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
8182
# **Submitting bulk requests with cURL**
8283
# If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.
8384
# The latter doesn't preserve newlines. For example:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module Actions
2828
# IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
2929
#
3030
# @option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
31-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
31+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3232
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3333
# Sorting defaults to ascending and can be changed by setting `:asc`
3434
# or `:desc` as a suffix to the column name.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module Actions
2828
#
2929
# @option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information.
3030
# @option arguments [String] :bytes The unit used to display byte values.
31-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
31+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3232
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3333
# Sorting defaults to ascending and can be changed by setting `:asc`
3434
# or `:desc` as a suffix to the column name.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module Actions
3131
# @option arguments [String] :name The name of the component template.
3232
# It accepts wildcard expressions.
3333
# If it is omitted, all component templates are returned.
34-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
34+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3535
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3636
# Sorting defaults to ascending and can be changed by setting `:asc`
3737
# or `:desc` as a suffix to the column name.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module Actions
3131
# @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
3232
# It supports wildcards (`*`).
3333
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
34-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
34+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3535
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3636
# Sorting defaults to ascending and can be changed by setting `:asc`
3737
# or `:desc` as a suffix to the column name.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ module Actions
3030
# @option arguments [String, Array<String>] :fields Comma-separated list of fields used to limit returned information.
3131
# To retrieve all fields, omit this parameter.
3232
# @option arguments [String] :bytes The unit used to display byte values.
33-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
33+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
3434
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3535
# Sorting defaults to ascending and can be changed by setting `:asc`
3636
# or `:desc` as a suffix to the column name.

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,12 @@ module Actions
2626
# By default, it returns only settings that have been explicitly defined.
2727
#
2828
# @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
29-
# @option arguments [Boolean] :include_defaults If `true`, returns default cluster settings from the local node.
29+
# @option arguments [Boolean] :include_defaults If `true`, also returns default values for all other cluster settings, reflecting the values
30+
# in the `elasticsearch.yml` file of one of the nodes in the cluster. If the nodes in your
31+
# cluster do not all have the same values in their `elasticsearch.yml` config files then the
32+
# values returned by this API may vary from invocation to invocation and may not reflect the
33+
# values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to
34+
# fetch the settings for each individual node in your cluster.
3035
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
3136
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
3237
# @option arguments [Time] :timeout Period to wait for a response.

elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ module Actions
3232
# It is valid only for the CSV format.
3333
# @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
3434
# If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
35-
# @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`.
35+
# @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout.
36+
# The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.
3637
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
3738
# when they occur.
3839
# @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/esql/query.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module Actions
2828
# minor version, meaning that your referencing code may break when this
2929
# library is upgraded.
3030
#
31-
# @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.
31+
# @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
3232
# @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
3333
# @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
3434
# Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ module Actions
3232
# - Update supported mapping parameters
3333
# - Change a field's mapping using reindexing
3434
# - Rename a field using a field alias
35-
# Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
35+
# Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
3636
#
3737
# @option arguments [String, Array] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. (*Required*)
3838
# @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.

0 commit comments

Comments
 (0)