Why are no javadocs available for the Java API?

After much searching about javadocs for the API, all I find is people asking this question. . . Why has no standard documentation been provided for the API? I haven't found a good response either. I see people have been asking for this for over four years now. Without documentation, I don't really know whether I'm reinventing wheels that already exist. The only documentation for Java is the 'by-example' documentation provided here: https://www.elastic.co/guide/en/elasticsearch/client/java-api/current/index.html

You are raising a very good point here. There has been work being done to to cleanup the situation on master here:

More on the status of online accessible JavaDocs here:

https://github.com/elastic/infra/issues/427

As far as I can see the full story is here: https://github.com/elastic/elasticsearch/issues/1203

My personal take from those issues: Any helping hand (in the form of pull requests) is highly welcome.

Sorry for not having better news,
Isabel

FWIW, there's a lingering pull request for re-enabling publishing of the Javadoc artifact: https://github.com/elastic/elasticsearch/pull/14935

It's just waiting to be merged (and it needs to be decided whether the doclint errors should be fixed first or simply ignored).

This might help you http://xbib.org/elasticsearch/1.5.1/apidocs/

Thank you! That is very helpful.

You can try this also for a newer version

http://xbib.org/elasticsearch/2.1.1/apidocs/

2 Likes

You have no idea how much time this has saved me. Thanks so much!

April 2016 - Still no JavaDocs? The links provided to older docs (at xbib.org) aren't working.

I found JavaDocs at:
https://www.javadoc.io/doc/org.elasticsearch/elasticsearch/2.3.0
and
http://javadoc.kyubu.de/elasticsearch/HEAD/

AFAIK it's there: http://search.maven.org/#artifactdetails|org.elasticsearch|elasticsearch|2.3.1|jar

1 Like

Thanks! Yet another hiding place. Thank you for this good link.