From 50d8a25d67e104bd5cf6180ff3238056e2a200fc Mon Sep 17 00:00:00 2001
From: olcbean <26058559+olcbean@users.noreply.github.com>
Date: Tue, 20 Feb 2018 18:37:53 +0100
Subject: [PATCH] [Docs] Java high-level REST client : clean up (#28703)
Make doc titles consistent with the ES docs and wrapping
the code snippets for better readability.
---
.../IndicesClientDocumentationIT.java | 39 +++++++++++++------
.../indices/update_aliases.asciidoc | 4 +-
2 files changed, 30 insertions(+), 13 deletions(-)
diff --git a/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/IndicesClientDocumentationIT.java b/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/IndicesClientDocumentationIT.java
index cb262db1b37..843c5c42fff 100644
--- a/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/IndicesClientDocumentationIT.java
+++ b/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/IndicesClientDocumentationIT.java
@@ -752,17 +752,31 @@ public class IndicesClientDocumentationIT extends ESRestHighLevelClientTestCase
{
// tag::update-aliases-request
IndicesAliasesRequest request = new IndicesAliasesRequest(); // <1>
- AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("alias1"); // <2>
+ AliasActions aliasAction =
+ new AliasActions(AliasActions.Type.ADD)
+ .index("index1")
+ .alias("alias1"); // <2>
request.addAliasAction(aliasAction); // <3>
// end::update-aliases-request
// tag::update-aliases-request2
- AliasActions addIndexAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("alias1")
- .filter("{\"term\":{\"year\":2016}}"); // <1>
- AliasActions addIndicesAction = new AliasActions(AliasActions.Type.ADD).indices("index1", "index2").alias("alias2")
- .routing("1"); // <2>
- AliasActions removeAction = new AliasActions(AliasActions.Type.REMOVE).index("index3").alias("alias3"); // <3>
- AliasActions removeIndexAction = new AliasActions(AliasActions.Type.REMOVE_INDEX).index("index4"); // <4>
+ AliasActions addIndexAction =
+ new AliasActions(AliasActions.Type.ADD)
+ .index("index1")
+ .alias("alias1")
+ .filter("{\"term\":{\"year\":2016}}"); // <1>
+ AliasActions addIndicesAction =
+ new AliasActions(AliasActions.Type.ADD)
+ .indices("index1", "index2")
+ .alias("alias2")
+ .routing("1"); // <2>
+ AliasActions removeAction =
+ new AliasActions(AliasActions.Type.REMOVE)
+ .index("index3")
+ .alias("alias3"); // <3>
+ AliasActions removeIndexAction =
+ new AliasActions(AliasActions.Type.REMOVE_INDEX)
+ .index("index4"); // <4>
// end::update-aliases-request2
// tag::update-aliases-request-timeout
@@ -775,7 +789,8 @@ public class IndicesClientDocumentationIT extends ESRestHighLevelClientTestCase
// end::update-aliases-request-masterTimeout
// tag::update-aliases-execute
- IndicesAliasesResponse indicesAliasesResponse = client.indices().updateAliases(request);
+ IndicesAliasesResponse indicesAliasesResponse =
+ client.indices().updateAliases(request);
// end::update-aliases-execute
// tag::update-aliases-response
@@ -783,13 +798,15 @@ public class IndicesClientDocumentationIT extends ESRestHighLevelClientTestCase
// end::update-aliases-response
assertTrue(acknowledged);
}
+
{
- IndicesAliasesRequest request = new IndicesAliasesRequest(); // <1>
- AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("async"); // <2>
+ IndicesAliasesRequest request = new IndicesAliasesRequest();
+ AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD).index("index1").alias("async");
request.addAliasAction(aliasAction);
// tag::update-aliases-execute-listener
- ActionListener<IndicesAliasesResponse> listener = new ActionListener<IndicesAliasesResponse>() {
+ ActionListener<IndicesAliasesResponse> listener =
+ new ActionListener<IndicesAliasesResponse>() {
@Override
public void onResponse(IndicesAliasesResponse indicesAliasesResponse) {
// <1>
diff --git a/docs/java-rest/high-level/indices/update_aliases.asciidoc b/docs/java-rest/high-level/indices/update_aliases.asciidoc
index 304613a9285..05c12e64911 100644
--- a/docs/java-rest/high-level/indices/update_aliases.asciidoc
+++ b/docs/java-rest/high-level/indices/update_aliases.asciidoc
@@ -1,10 +1,10 @@
[[java-rest-high-update-aliases]]
-=== Update Aliases API
+=== Index Aliases API
[[java-rest-high-update-aliases-request]]
==== Indices Aliases Request
-The Update Aliases API allows aliasing an index with a name, with all APIs
+The Index Aliases API allows aliasing an index with a name, with all APIs
automatically converting the alias name to the actual index name.
An `IndicesAliasesRequest` must have at least one `AliasActions`: