Skip to content

Commit

Permalink
Updated opensearch-py to reflect the latest OpenSearch API spec (2024…
Browse files Browse the repository at this point in the history
…-04-24) (#734)

Signed-off-by: GitHub <[email protected]>
Co-authored-by: saimedhi <[email protected]>
  • Loading branch information
opensearch-trigger-bot[bot] and saimedhi authored Apr 24, 2024
1 parent fd48eb4 commit 303b6c6
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Fixed
- Updated code generator to use native OpenAPI specification ([#721](https://github.com/opensearch-project/opensearch-py/pull/721))
### Updated APIs
- Updated opensearch-py APIs to reflect [opensearch-api-specification@3ed6aaf](https://github.com/opensearch-project/opensearch-api-specification/commit/3ed6aaff0ce51af3aad00fe57c34d1a7056bd6d1)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@af4a34f](https://github.com/opensearch-project/opensearch-api-specification/commit/af4a34f9847d36709b5a394be7c76fda4649ccc8)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@e02c076](https://github.com/opensearch-project/opensearch-api-specification/commit/e02c076ef63f7a9b650ca1416380120cc640620a)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@fe6f977](https://github.com/opensearch-project/opensearch-api-specification/commit/fe6f977bcae4e27a2b261fb9599884df5606c0bc)
Expand Down
25 changes: 25 additions & 0 deletions opensearchpy/_async/plugins/notifications.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,3 +324,28 @@ async def update_config(
headers=headers,
body=body,
)

@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def list_channels(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
List created notification channels.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return await self.transport.perform_request(
"GET", "/_plugins/_notifications/channels", params=params, headers=headers
)
25 changes: 25 additions & 0 deletions opensearchpy/plugins/notifications.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,3 +324,28 @@ def update_config(
headers=headers,
body=body,
)

@query_params("error_trace", "filter_path", "human", "pretty", "source")
def list_channels(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
List created notification channels.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return self.transport.perform_request(
"GET", "/_plugins/_notifications/channels", params=params, headers=headers
)

0 comments on commit 303b6c6

Please sign in to comment.