Skip to content

Commit 32b18a7

Browse files
committed
[DOCS] add links to javadocs to clients docs
We publish javadocs to artifacts.elastic.co (and snapshots.elastic.co) for a while. This commit adds the link to them to the transport client, low level REST client, sniffer and high level REST client pages. Closes #23761
1 parent 57e8b9e commit 32b18a7

File tree

5 files changed

+27
-1
lines changed

5 files changed

+27
-1
lines changed

docs/Versions.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,19 @@ Javadoc roots used to generate links from Painless's API reference
2727

2828
ifeval::["{release-state}"=="unreleased"]
2929
:elasticsearch-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}-SNAPSHOT
30+
:transport-client-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/transport/{version}-SNAPSHOT
31+
:rest-client-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/{version}-SNAPSHOT
32+
:rest-client-sniffer-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client-sniffer/{version}-SNAPSHOT
33+
:rest-high-level-client-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-high-level-client/{version}-SNAPSHOT
3034
:painless-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}-SNAPSHOT
3135
endif::[]
3236

3337
ifeval::["{release-state}"!="unreleased"]
3438
:elasticsearch-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}
39+
:transport-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/transport/{version}-SNAPSHOT
40+
:rest-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/{version}-SNAPSHOT
41+
:rest-client-sniffer-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client-sniffer/{version}-SNAPSHOT
42+
:rest-high-level-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-high-level-client/{version}-SNAPSHOT
3543
:painless-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}
3644
endif::[]
3745

docs/java-api/index.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ Additionally, operations on a client may be accumulated and executed in
1717
Note, all the APIs are exposed through the
1818
Java API (actually, the Java API is used internally to execute them).
1919

20+
== Javadoc
21+
22+
The javadoc for the transport client can be found at {transport-client-javadoc}/index.html.
2023

2124
== Maven Repository
2225

docs/java-rest/high-level/usage.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
This section describes how to get started with the high-level REST client from
55
getting the artifact to using it in an application.
66

7+
[[java-rest-high-javadoc]]
8+
=== Javadoc
9+
10+
The javadoc for the REST high level client can be found at {rest-high-level-client-javadoc}/index.html.
11+
712
[[java-rest-high-usage-maven]]
813
=== Maven Repository
914

docs/java-rest/low-level/sniffer.asciidoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@ Nodes Info api and uses jackson to parse the obtained json response.
88

99
Compatible with Elasticsearch 2.x and onwards.
1010

11+
[[java-rest-sniffer-javadoc]]
12+
=== Javadoc
13+
14+
The javadoc for the REST client sniffer can be found at {rest-client-sniffer-javadoc}/index.html.
15+
1116
=== Maven Repository
1217

13-
The low-level REST client is subject to the same release cycle as
18+
The REST client sniffer is subject to the same release cycle as
1419
elasticsearch. Replace the version with the desired sniffer version, first
1520
released with `5.0.0-alpha4`. There is no relation between the sniffer version
1621
and the elasticsearch version that the client can communicate with. Sniffer

docs/java-rest/low-level/usage.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
This section describes how to get started with the low-level REST client from
55
getting the artifact to using it in an application.
66

7+
[[java-rest-low-javadoc]]
8+
=== Javadoc
9+
10+
The javadoc for the low level REST client can be found at {rest-client-javadoc}/index.html.
11+
712
[[java-rest-low-usage-maven]]
813
=== Maven Repository
914

0 commit comments

Comments
 (0)