Skip to content

Commit eaac096

Browse files
Auto-generated API code
1 parent 1cb6848 commit eaac096

File tree

5 files changed

+30
-22
lines changed

5 files changed

+30
-22
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4652,11 +4652,11 @@ async def search(
46524652
of the specified nodes are available, select shards from any available node
46534653
using the default method. * `_prefer_nodes:<node-id>,<node-id>` to if possible,
46544654
run the search on the specified nodes IDs. If not, select shards using the
4655-
default method. `_shards:<shard>,<shard>` to run the search only on the specified
4656-
shards. You can combine this value with other `preference` values. However,
4657-
the `_shards` value must come first. For example: `_shards:2,3|_local`. `<custom-string>`
4658-
(any string that does not start with `_`) to route searches with the same
4659-
`<custom-string>` to the same shards in the same order.
4655+
default method. * `_shards:<shard>,<shard>` to run the search only on the
4656+
specified shards. You can combine this value with other `preference` values.
4657+
However, the `_shards` value must come first. For example: `_shards:2,3|_local`.
4658+
* `<custom-string>` (any string that does not start with `_`) to route searches
4659+
with the same `<custom-string>` to the same shards in the same order.
46604660
:param profile: Set to `true` to return detailed timing information about the
46614661
execution of individual components in a search request. NOTE: This is a debugging
46624662
tool and adds significant overhead to search execution.

elasticsearch/_async/client/indices.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,15 @@ async def create(
656656
657657
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create>`_
658658
659-
:param index: Name of the index you wish to create.
659+
:param index: Name of the index you wish to create. Index names must meet the
660+
following criteria: * Lowercase only * Cannot include `\\`, `/`, `*`, `?`,
661+
`"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to
662+
7.0 could contain a colon (`:`), but that has been deprecated and will not
663+
be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot
664+
be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes,
665+
so multi-byte characters will reach the limit faster) * Names starting with
666+
`.` are deprecated, except for hidden indices and internal indices managed
667+
by plugins
660668
:param aliases: Aliases for the index.
661669
:param mappings: Mapping for fields in the index. If specified, this mapping
662670
can include: - Field names - Field data types - Mapping parameters

elasticsearch/_sync/client/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4650,11 +4650,11 @@ def search(
46504650
of the specified nodes are available, select shards from any available node
46514651
using the default method. * `_prefer_nodes:<node-id>,<node-id>` to if possible,
46524652
run the search on the specified nodes IDs. If not, select shards using the
4653-
default method. `_shards:<shard>,<shard>` to run the search only on the specified
4654-
shards. You can combine this value with other `preference` values. However,
4655-
the `_shards` value must come first. For example: `_shards:2,3|_local`. `<custom-string>`
4656-
(any string that does not start with `_`) to route searches with the same
4657-
`<custom-string>` to the same shards in the same order.
4653+
default method. * `_shards:<shard>,<shard>` to run the search only on the
4654+
specified shards. You can combine this value with other `preference` values.
4655+
However, the `_shards` value must come first. For example: `_shards:2,3|_local`.
4656+
* `<custom-string>` (any string that does not start with `_`) to route searches
4657+
with the same `<custom-string>` to the same shards in the same order.
46584658
:param profile: Set to `true` to return detailed timing information about the
46594659
execution of individual components in a search request. NOTE: This is a debugging
46604660
tool and adds significant overhead to search execution.

elasticsearch/_sync/client/indices.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,15 @@ def create(
656656
657657
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create>`_
658658
659-
:param index: Name of the index you wish to create.
659+
:param index: Name of the index you wish to create. Index names must meet the
660+
following criteria: * Lowercase only * Cannot include `\\`, `/`, `*`, `?`,
661+
`"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to
662+
7.0 could contain a colon (`:`), but that has been deprecated and will not
663+
be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot
664+
be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes,
665+
so multi-byte characters will reach the limit faster) * Names starting with
666+
`.` are deprecated, except for hidden indices and internal indices managed
667+
by plugins
660668
:param aliases: Aliases for the index.
661669
:param mappings: Mapping for fields in the index. If specified, this mapping
662670
can include: - Field names - Field data types - Mapping parameters

elasticsearch/dsl/types.py

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1561,11 +1561,7 @@ class InnerHits(AttrDict[Any]):
15611561
DefaultType,
15621562
]
15631563
seq_no_primary_term: Union[bool, DefaultType]
1564-
fields: Union[
1565-
Union[str, InstrumentedField],
1566-
Sequence[Union[str, InstrumentedField]],
1567-
DefaultType,
1568-
]
1564+
fields: Union[Sequence[Union[str, InstrumentedField]], DefaultType]
15691565
sort: Union[
15701566
Union[Union[str, InstrumentedField], "SortOptions"],
15711567
Sequence[Union[Union[str, InstrumentedField], "SortOptions"]],
@@ -1600,11 +1596,7 @@ def __init__(
16001596
DefaultType,
16011597
] = DEFAULT,
16021598
seq_no_primary_term: Union[bool, DefaultType] = DEFAULT,
1603-
fields: Union[
1604-
Union[str, InstrumentedField],
1605-
Sequence[Union[str, InstrumentedField]],
1606-
DefaultType,
1607-
] = DEFAULT,
1599+
fields: Union[Sequence[Union[str, InstrumentedField]], DefaultType] = DEFAULT,
16081600
sort: Union[
16091601
Union[Union[str, InstrumentedField], "SortOptions"],
16101602
Sequence[Union[Union[str, InstrumentedField], "SortOptions"]],

0 commit comments

Comments
 (0)