API Reference - python docs please!

[jtlz2]

Is your feature request related to a problem?

I am always frustrated because in spite of sample documentation online there is an absence of a python API reference and/or easy-to-find docstrings. I have to go digging into the code to figure out function signatures. It would really speed up development if you would be able to post this somewhere.

What solution would you like?
An online API reference on e.g. readthedocs.io

What alternatives have you considered?
Sample code on SO or on github, plus digging into the code (time consuming and difficult to interpret!).

Do you have any additional context?
Please advise if I am missing where this is. If it's there, please simply make it easier to find!

Many thanks!

[VachaShah]

Hi @jtlz2, @PhilipMay recently added the Sphinx link https://opensearch-project.github.io/opensearch-py/. Hope that helps!

[jtlz2]

@VachaShah @PhilipMay Thank you - that is 💯 what I needed! Please could you make it more prominent around the place? If you hadn't told me I don't think I'd have found it. Thanks again!

[PhilipMay]

Please could you make it more prominent around the place?

@jtlz2 what exactly do you mean? Maybe you want to provide a PR?

[CameronNemo]

@PhilipMay on this page would be nice: https://opensearch.org/docs/latest/clients/python/ ; and perhaps in the README / PyPI.

[PhilipMay]

@PhilipMay on this page would be nice: https://opensearch.org/docs/latest/clients/python/ ; and perhaps in the README / PyPI.

It is already part of the README and will automatically be part of the pypi page on next release.

About https://opensearch.org/docs/latest/clients/python/ I do not know.

[jspreddy]

I am still having to dig through the code base to figure things out. The python API documentation here is not complete. It only contains docs for top level classes.

For example on this page: https://opensearch-project.github.io/opensearch-py/api-ref/client.html it says to use the attributes and that attributes are instances of classes. But those classes are not in the docs.

The instance has attributes cat, cluster, indices, ingest, nodes, snapshot and tasks that provide access to instances of CatClient, ClusterClient, IndicesClient, IngestClient, NodesClient, SnapshotClient and TasksClient respectively. This is the preferred (and only supported) way to get access to those classes and their methods.

None of these classes are available in the api reference page or on the index page.

[harshavamsi]

@jspreddy the docs need improvement. Would you be willing to contribute a PR for the ones you see lacking?

[jaydm26]

@harshavamsi Happy to take this up, if no one has volunteered yet

[harshavamsi]

Hi @jaydm26, absolutely go for it. Thanks!

[jaydm26]

Hey @harshavamsi, I have raised a PR #204

[VachaShah]

Closing this issue since docs have been added.