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

[Documentation] Access to specialized clients is not documented #2539

Open
maximekuntz opened this issue May 2, 2024 · 1 comment
Open

Comments

@maximekuntz
Copy link

On Read the docs, the way to get specialized clients such as IndicesClient, TransformClient... is not explained.

These clients are accessible using Elasticsearch().indices and Elasticsearch().transform... but it is not documented. It currently has to be infered from the few examples (examples: https://elasticsearch-py.readthedocs.io/en/v8.13.0/quickstart.html#deleting-an-index, https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/examples.html#ex-refresh).

The documentation should explain it. At least, more examples would be very helpful.

@pquentin
Copy link
Member

pquentin commented May 3, 2024

Thanks, you're right that it's a serious gap in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants