fixes: #512 Wrong return type hint in async_scan (#520)

* fixes: #512 Wrong return type hint in async_scan Signed-off-by: Bhavani Ravi <[email protected]> * add: changelog Signed-off-by: Bhavani Ravi <[email protected]> --------- Signed-off-by: Bhavani Ravi <[email protected]>
opensearch-project · Oct 3, 2023 · 1a47e6f · 1a47e6f
1 parent 70db37a
commit 1a47e6f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -125,6 +125,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Removed patch versions in integration tests for OpenSearch 1.0.0 - 2.3.0 to reduce Github Action jobs ([#262](https://github.com/opensearch-project/opensearch-py/pull/262))
 ### Fixed
 - Fixed DeprecationWarning emitted from urllib3 1.26.13+ ([#246](https://github.com/opensearch-project/opensearch-py/pull/246))
+- Fixed Wrong return type hint in `async_scan` ([520](https://github.com/opensearch-project/opensearch-py/pull/520))
 ### Security
 
 [Unreleased]: https://github.com/opensearch-project/opensearch-py/compare/v2.3.1...HEAD

diff --git a/opensearchpy/_async/helpers/actions.pyi b/opensearchpy/_async/helpers/actions.pyi
@@ -100,7 +100,7 @@ def async_scan(
     clear_scroll: bool = ...,
     scroll_kwargs: Optional[Mapping[str, Any]] = ...,
     **kwargs: Any
-) -> AsyncGenerator[int, None]: ...
+) -> AsyncGenerator[dict[str, Any], None]: ...
 async def async_reindex(
     client: AsyncOpenSearch,
     source_index: Union[str, Collection[str]],