opensearch-project / opensearch-py

Python Client for OpenSearch

https://opensearch.org/docs/latest/clients/python/

Apache License 2.0

359 stars 178 forks source link

Opensearch client docs #720

Closed Plutone11011 closed 5 months ago

Plutone11011 commented 7 months ago

Description

Updates opensearch client docstrings and user guide for index, deleteand createmethods

Issues Resolved

718

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.

Plutone11011 commented 7 months ago

Btw I cannot run the linter or formatter with nox, since it tells me that "Python 3.8" is not found, and I am using Python 3.9. Is 3.8 a hard requirement?

saimedhi commented 7 months ago

Hi @Plutone11011, just a quick note: APIs, along with their descriptions, are automatically generated from the spec. Anything you've added will get replaced next time the generator runs.

If you happen to have any extra tips or instructions on using the APIs, could you kindly place them in the guides folder? Your help is greatly appreciated!

saimedhi commented 5 months ago

Hello @Plutone11011 ,

I am closing this PR. Please consider contributing to the guides as discussed. Your help would be greatly appreciated. Thanks a lot for your efforts!