Browse Source

[Docs] Clarify that _ccr/info omits parameters from the response when the follower index is paused. (#55961)

CJ Cenizal 5 years ago
parent
commit
cde5126620
1 changed files with 34 additions and 10 deletions
  1. 34 10
      docs/reference/ccr/apis/follow/get-follow-info.asciidoc

+ 34 - 10
docs/reference/ccr/apis/follow/get-follow-info.asciidoc

@@ -23,13 +23,6 @@ PUT /follower_index/_ccr/follow?wait_for_active_shards=1
 --------------------------------------------------
 // TESTSETUP
 // TEST[setup:remote_cluster_and_leader_index]
-
-[source,console]
---------------------------------------------------
-POST /follower_index/_ccr/pause_follow
---------------------------------------------------
-// TEARDOWN
-
 //////////////////////////
 
 [source,console]
@@ -76,7 +69,8 @@ replication options and whether the follower indices are active or paused.
 
 //Begin parameters
 `parameters`::
-(object) An object that encapsulates {ccr} parameters.
+(object) An object that encapsulates {ccr} parameters. If the follower index's `status` is `paused`,
+this object is omitted.
 +
 .Properties of `parameters`
 [%collapsible%open]
@@ -132,7 +126,7 @@ to read from the leader again.
 leader index.
 
 `status`::
-(string) Whether index following is `active` or `paused`. 
+(string) Whether index following is `active` or `paused`.
 ====
 //End follower_indices
 
@@ -146,7 +140,7 @@ This example retrieves follower info:
 GET /follower_index/_ccr/info
 --------------------------------------------------
 
-The API returns the following results:
+If the follower index is `active`, the API returns the following results:
 
 [source,console-result]
 --------------------------------------------------
@@ -173,3 +167,33 @@ The API returns the following results:
     ]
 }
 --------------------------------------------------
+
+////
+[source,console]
+--------------------------------------------------
+POST /follower_index/_ccr/pause_follow
+--------------------------------------------------
+// TEST[continued]
+
+[source,console]
+--------------------------------------------------
+GET /follower_index/_ccr/info
+--------------------------------------------------
+// TEST[continued]
+////
+
+If the follower index is `paused`, the API returns the following results:
+
+[source,console-result]
+--------------------------------------------------
+{
+    "follower_indices" : [
+        {
+            "follower_index" : "follower_index",
+            "remote_cluster" : "remote_cluster",
+            "leader_index" : "leader_index",
+            "status" : "paused"
+        }
+    ]
+}
+--------------------------------------------------