Skip to content

Commit 1cc1b11

Browse files
Auto-generated API code
1 parent a67c2ee commit 1cc1b11

File tree

12 files changed

+598
-22
lines changed

12 files changed

+598
-22
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -608,6 +608,7 @@ async def bulk(
608608
<li>JavaScript: Check out <code>client.helpers.*</code></li>
609609
<li>.NET: Check out <code>BulkAllObservable</code></li>
610610
<li>PHP: Check out bulk indexing.</li>
611+
<li>Ruby: Check out <code>Elasticsearch::Helpers::BulkHelper</code></li>
611612
</ul>
612613
<p><strong>Submitting bulk requests with cURL</strong></p>
613614
<p>If you're providing text file input to <code>curl</code>, you must use the <code>--data-binary</code> flag instead of plain <code>-d</code>.
@@ -5659,7 +5660,7 @@ async def termvectors(
56595660
doc: t.Optional[t.Mapping[str, t.Any]] = None,
56605661
error_trace: t.Optional[bool] = None,
56615662
field_statistics: t.Optional[bool] = None,
5662-
fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
5663+
fields: t.Optional[t.Sequence[str]] = None,
56635664
filter: t.Optional[t.Mapping[str, t.Any]] = None,
56645665
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
56655666
human: t.Optional[bool] = None,

elasticsearch/_async/client/cluster.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,8 +374,13 @@ async def get_settings(
374374
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings>`_
375375
376376
:param flat_settings: If `true`, returns settings in flat format.
377-
:param include_defaults: If `true`, returns default cluster settings from the
378-
local node.
377+
:param include_defaults: If `true`, also returns default values for all other
378+
cluster settings, reflecting the values in the `elasticsearch.yml` file of
379+
one of the nodes in the cluster. If the nodes in your cluster do not all
380+
have the same values in their `elasticsearch.yml` config files then the values
381+
returned by this API may vary from invocation to invocation and may not reflect
382+
the values that Elasticsearch uses in all situations. Use the `GET _nodes/settings`
383+
API to fetch the settings for each individual node in your cluster.
379384
:param master_timeout: Period to wait for a connection to the master node. If
380385
no response is received before the timeout expires, the request fails and
381386
returns an error.

elasticsearch/_async/client/esql.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,12 @@ async def async_query(
111111
which has the name of all the columns.
112112
:param filter: Specify a Query DSL query in the filter parameter to filter the
113113
set of documents that an ES|QL query runs on.
114-
:param format: A short version of the Accept header, for example `json` or `yaml`.
114+
:param format: A short version of the Accept header, e.g. json, yaml. `csv`,
115+
`tsv`, and `txt` formats will return results in a tabular format, excluding
116+
other metadata fields from the response. For async requests, nothing will
117+
be returned if the async query doesn't finish within the timeout. The query
118+
ID and running status are available in the `X-Elasticsearch-Async-Id` and
119+
`X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.
115120
:param include_ccs_metadata: When set to `true` and performing a cross-cluster
116121
query, the response will include an extra `_clusters` object with information
117122
about the clusters that participated in the search along with info such as
@@ -539,7 +544,9 @@ async def query(
539544
`all_columns` which has the name of all columns.
540545
:param filter: Specify a Query DSL query in the filter parameter to filter the
541546
set of documents that an ES|QL query runs on.
542-
:param format: A short version of the Accept header, e.g. json, yaml.
547+
:param format: A short version of the Accept header, e.g. json, yaml. `csv`,
548+
`tsv`, and `txt` formats will return results in a tabular format, excluding
549+
other metadata fields from the response.
543550
:param include_ccs_metadata: When set to `true` and performing a cross-cluster
544551
query, the response will include an extra `_clusters` object with information
545552
about the clusters that participated in the search along with info such as

elasticsearch/_async/client/indices.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4179,7 +4179,7 @@ async def put_mapping(
41794179
<li>Change a field's mapping using reindexing</li>
41804180
<li>Rename a field using a field alias</li>
41814181
</ul>
4182-
<p>Learn how to use the update mapping API with practical examples in the <a href="https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples">Update mapping API examples</a> guide.</p>
4182+
<p>Learn how to use the update mapping API with practical examples in the <a href="https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples">Update mapping API examples</a> guide.</p>
41834183
41844184
41854185
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping>`_

0 commit comments

Comments
 (0)