Skip to content

Promote client stability in docs #27

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

Merged
merged 1 commit into from
Oct 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/connecting.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[connecting]]
== Connecting

experimental[]
beta[]

The code snippet below shows how to initialize a low level REST client and the
The code snippet below shows how to initialize a low level REST client and the
Jackson object mapper to configure an ElasticsearchClient:


Expand All @@ -19,7 +19,7 @@ Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper
ElasticsearchClient client = new ElasticsearchClient(transport);
--------------------------------------------------

Authentication is managed by the
Authentication is managed by the
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low.html[low-level Rest Client].
For further details on configuring authentication, refer to the
For further details on configuring authentication, refer to the
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/_basic_authentication.html[documentation].
32 changes: 16 additions & 16 deletions docs/installation.asciidoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
[[installation]]
== Installation

experimental[]
beta[]

This page guides you through the installation process of the client.

Requirements:

* Java 8 or later. The library provides high-level type-safe classes
and methods for all {es} APIs. It sits on top of the
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low.html[Low Level Rest Client]
* Java 8 or later. The library provides high-level type-safe classes
and methods for all {es} APIs. It sits on top of the
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low.html[Low Level Rest Client]
that manages all http communications.
* The JSON implementation used by the Java client is pluggable and you must add
a JSON object mapping library as a dependency to your project. It has support
for https://github.com/FasterXML/jackson[Jackson] or a
http://json-b.net/[JSON-B] library like

* The JSON implementation used by the Java client is pluggable and you must add
a JSON object mapping library as a dependency to your project. It has support
for https://github.com/FasterXML/jackson[Jackson] or a
http://json-b.net/[JSON-B] library like
https://github.com/eclipse-ee4j/yasson[Eclipse Yasson].


Expand All @@ -39,7 +39,7 @@ dependencies {
[[maven]]
=== Installation in a Maven project by using Jackson

In the `pom.xml` of your project, add the following repository definition and
In the `pom.xml` of your project, add the following repository definition and
dependencies:

["source","xml",subs="attributes"]
Expand All @@ -66,11 +66,11 @@ dependencies:
[[compatibility]]
=== Compatibility

The `main` branch targets the next major release (8.0), the `7.x` branch targets
the next minor release. Support is still incomplete as the API code is generated
The `main` branch targets the next major release (8.0), the `7.x` branch targets
the next minor release. Support is still incomplete as the API code is generated
from the {es} Specification that is also still a work in progress.

The {es} Java client is forward compatible; meaning that the client supports
communicating with greater or equal minor versions of {es}. {es} language
clients are only backwards compatible with default distributions and without
guarantees made.
The {es} Java client is forward compatible; meaning that the client supports
communicating with greater or equal minor versions of {es}. {es} language
clients are only backwards compatible with default distributions and without
guarantees made.
10 changes: 5 additions & 5 deletions docs/introduction.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[introduction]]
== Introduction

experimental[]
beta[]

This is the official Java API client for {es}. The client provides strongly
typed requests and responses for all {es} APIs. It delegates protocol handling
to an http client such as the
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/master/java-rest-low.html[{es} Low Level REST client]
This is the official Java API client for {es}. The client provides strongly
typed requests and responses for all {es} APIs. It delegates protocol handling
to an http client such as the
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/master/java-rest-low.html[{es} Low Level REST client]
that takes care of all transport-level concerns.