Skip to content

Commit f5ef694

Browse files
Updated opensearch-py to reflect the latest OpenSearch API spec (2026-01-22) (#994)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: saimedhi <117196660+saimedhi@users.noreply.github.com>
1 parent 10ab792 commit f5ef694

File tree

7 files changed

+1229
-28
lines changed

7 files changed

+1229
-28
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
66
- Add dependency on opensearch-protobufs to provide client libraries for gRPC transport ([#977](https://github.com/opensearch-project/opensearch-py/pull/977))
77
- Add ML Commons plugin documentation ([#992](https://github.com/opensearch-project/opensearch-py/pull/992))
88
### Updated APIs
9+
- Updated opensearch-py APIs to reflect [opensearch-api-specification@2954600](https://github.com/opensearch-project/opensearch-api-specification/commit/2954600ddafbd98a1ab9f530054bb1b62380a92a)
910
### Changed
1011
### Deprecated
1112
### Removed

opensearchpy/_async/client/__init__.py

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -380,8 +380,7 @@ async def create(
380380
The specified version must match the current version of the document for
381381
the request to succeed.
382382
:arg version_type: The specific version type: `external`,
383-
`external_gte`. Valid choices are external, external_gte, force,
384-
internal.
383+
`external_gte`. Valid choices are external, external_gte, internal.
385384
:arg wait_for_active_shards: The number of shard copies that
386385
must be active before proceeding with the operation. Set to `all` or any
387386
positive integer up to the total number of shards in the index
@@ -472,8 +471,7 @@ async def index(
472471
The specified version must match the current version of the document for
473472
the request to succeed.
474473
:arg version_type: The specific version type: `external`,
475-
`external_gte`. Valid choices are external, external_gte, force,
476-
internal.
474+
`external_gte`. Valid choices are external, external_gte, internal.
477475
:arg wait_for_active_shards: The number of shard copies that
478476
must be active before proceeding with the operation. Set to all or any
479477
positive integer up to the total number of shards in the index
@@ -761,8 +759,7 @@ async def delete(
761759
The specified version must match the current version of the document for
762760
the request to succeed.
763761
:arg version_type: The specific version type: `external`,
764-
`external_gte`. Valid choices are external, external_gte, force,
765-
internal.
762+
`external_gte`. Valid choices are external, external_gte, internal.
766763
:arg wait_for_active_shards: The number of shard copies that
767764
must be active before proceeding with the operation. Set to `all` or any
768765
positive integer up to the total number of shards in the index
@@ -1091,8 +1088,7 @@ async def exists(
10911088
The specified version must match the current version of the document for
10921089
the request to succeed.
10931090
:arg version_type: The specific version type: `external`,
1094-
`external_gte`. Valid choices are external, external_gte, force,
1095-
internal.
1091+
`external_gte`. Valid choices are external, external_gte, internal.
10961092
"""
10971093
for param in (index, id):
10981094
if param in SKIP_IN_PATH:
@@ -1162,8 +1158,7 @@ async def exists_source(
11621158
The specified version must match the current version of the document for
11631159
the request to succeed.
11641160
:arg version_type: The specific version type: `external`,
1165-
`external_gte`. Valid choices are external, external_gte, force,
1166-
internal.
1161+
`external_gte`. Valid choices are external, external_gte, internal.
11671162
"""
11681163
for param in (index, id):
11691164
if param in SKIP_IN_PATH:
@@ -1389,7 +1384,7 @@ async def get(
13891384
the request to succeed.
13901385
:arg version_type: The specific version type: `internal`,
13911386
`external`, `external_gte`. Valid choices are external, external_gte,
1392-
force, internal.
1387+
internal.
13931388
"""
13941389
for param in (index, id):
13951390
if param in SKIP_IN_PATH:
@@ -1504,7 +1499,7 @@ async def get_source(
15041499
the request to succeed.
15051500
:arg version_type: The specific version type. One of `internal`,
15061501
`external`, `external_gte`. Valid choices are external, external_gte,
1507-
force, internal.
1502+
internal.
15081503
"""
15091504
for param in (index, id):
15101505
if param in SKIP_IN_PATH:
@@ -1812,7 +1807,7 @@ async def mtermvectors(
18121807
:arg version: If `true`, returns the document version as part of
18131808
a hit.
18141809
:arg version_type: The specific version type. Valid choices are
1815-
external, external_gte, force, internal.
1810+
external, external_gte, internal.
18161811
"""
18171812
path = _make_path(index, "_mtermvectors")
18181813

@@ -2689,7 +2684,7 @@ async def termvectors(
26892684
:arg version: If `true`, returns the document version as part of
26902685
a hit.
26912686
:arg version_type: The specific version type. Valid choices are
2692-
external, external_gte, force, internal.
2687+
external, external_gte, internal.
26932688
"""
26942689
if index in SKIP_IN_PATH:
26952690
raise ValueError("Empty value passed for a required argument 'index'.")

0 commit comments

Comments
 (0)