From 4219f8e06273d764ab935537f5a0cdd1dbaccda4 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Thu, 10 Mar 2016 14:09:04 +0100 Subject: [PATCH] Updated Java API docs with version recommendations Closes #15188 --- docs/java-api/client.asciidoc | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/java-api/client.asciidoc b/docs/java-api/client.asciidoc index 7eea693d432..86b9b56cae7 100644 --- a/docs/java-api/client.asciidoc +++ b/docs/java-api/client.asciidoc @@ -12,12 +12,16 @@ Obtaining an elasticsearch `Client` is simple. The most common way to get a client is by creating a <> that connects to a cluster. -*Important:* -______________________________________________________________________________________________________________________________________________________________ -Please note that you are encouraged to use the same version on client -and cluster sides. You may hit some incompatibility issues when mixing -major versions. -______________________________________________________________________________________________________________________________________________________________ +[IMPORTANT] +============================== + +The client must have the same major version (e.g. `2.x`, or `5.x`) as the +nodes in the cluster. Clients may connect to clusters which have a different +minor version (e.g. `2.3.x`) but it is possible that new funcionality may not +be supported. Ideally, the client should have the same version as the +cluster. + +============================== [[transport-client]]