Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated user_guide for async client #338

Merged
merged 1 commit into from
Mar 24, 2023

Conversation

saimedhi
Copy link
Collaborator

Description

Updated user_guide for async client

Issues Resolved

Closes #332

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: saimedhi <saimedhi@amazon.com>
@@ -478,6 +478,10 @@ print(response)

Make sure to use `AsyncOpenSearch` with the `AsyncHttpConnection` connection class with the async `AWSV4SignerAsyncAuth` signer.

```bash
pip install opensearch-py[async]
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. I think we can reorganize the guide a bit. We have sections like "Pre-requisites to use AWSV4SignerAuth", maybe you want to do a pass and consolidate these things into Setup? Just thinking out loud.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @dblock, take a look at this draft PR. Do I need to merge "Pre-requisites to use" into "Setup" and also do you want me to make any other changes.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I commented on that PR. It's really NBD.

@dblock dblock merged commit 51eb6e5 into opensearch-project:main Mar 24, 2023
roma2023 pushed a commit to roma2023/opensearch-py that referenced this pull request May 9, 2023
Signed-off-by: saimedhi <saimedhi@amazon.com>
Signed-off-by: Raman Saparkhan <romasaparhan19@gmail.com>
roma2023 pushed a commit to roma2023/opensearch-py that referenced this pull request Jul 4, 2023
Signed-off-by: saimedhi <saimedhi@amazon.com>
Signed-off-by: Raman Saparkhan <romasaparhan19@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Unable to import AsyncOpenSearch from opensearch-py v2.2.0
2 participants