Skip to content

Commit 6fbe1cd

Browse files
committed
Apply feedback
1 parent c3c86a4 commit 6fbe1cd

9 files changed

+52
-50
lines changed

docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Delete auto-follow patterns.
1010

1111
==== Description
1212

13-
This API deletes configured auto-follow patterns.
13+
This API deletes a configured auto-follow pattern collection.
1414

1515
==== Request
1616

@@ -41,13 +41,14 @@ DELETE /_ccr/auto_follow/<auto_follow_pattern_name>
4141
// CONSOLE
4242
// TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/]
4343

44-
Here, the auto-follow patterns associated with the
45-
<<modules-remote-clusters,remote cluster>> specified by `<leader_cluster>`
46-
will be deleted.
44+
==== Path Components
45+
`auto_follow_pattern_name` (required)::
46+
(string) specifies the auto-follow pattern collection to delete
4747

4848
==== Example
4949

50-
The following is an example of using the delete auto-follow pattern API.
50+
This example deletes an auto-follow pattern collection named
51+
`my_auto_follow_pattern`:
5152

5253
[source,js]
5354
--------------------------------------------------

docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,23 @@ GET /_ccr/auto_follow/
4949
--------------------------------------------------
5050
// CONSOLE
5151

52-
Here, all auto-follow patterns will be returned.
53-
5452
[source,js]
5553
--------------------------------------------------
5654
GET /_ccr/auto_follow/<auto_follow_pattern_name>
5755
--------------------------------------------------
5856
// CONSOLE
5957
// TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/]
6058

61-
Here, the named auto-follow pattern collection specified by
62-
`<auto_follow_pattern_name>` will be returned.
59+
==== Path Components
60+
`auto_follow_pattern_name`::
61+
(string) specifies the auto-follow pattern collection that you want to
62+
retrieve; if you do not specify a name, the API returns information for all
63+
collections
6364

6465
==== Example
6566

66-
The following is an example of using the get auto-follow pattern API.
67+
This example retrieves information about an auto-follow pattern collection
68+
named `my_auto_follow_pattern`:
6769

6870
[source,js]
6971
--------------------------------------------------

docs/reference/ccr/apis/auto-follow/get-auto-follow-stats.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@ GET /_ccr/auto_follow/stats
2121
// CONSOLE
2222
// TEST
2323

24-
Here, stats about auto-follow patterns will be returned.
25-
2624
==== Example
2725

28-
The following is an example of using the get auto-follow stats API.
26+
This example retrieves stats about auto-follow patterns:
2927

3028
[source,js]
3129
--------------------------------------------------

docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,9 @@ DELETE /_ccr/auto_follow/auto_follow_pattern_name
4747
4848
//////////////////////////
4949

50-
Here, `<auto_follow_pattern_name>` is a user-chosen name for the collection of
51-
auto-follow patterns being created, `<leader_cluster>` is the
52-
<<modules-remote-clusters,remote cluster>> containing the leader indices to
53-
match against, `<leader_index_pattern>` is a simple index pattern to match
54-
against indices in the remote cluster, and `<follow_index_pattern>` is the
55-
pattern to use to name the resulting follower indices. The
56-
`<follow_index_pattern>` can use the template `{{leader_index}}` to refer to the
57-
name of the leader index being followed.
50+
==== Path Components
51+
`auto_follow_pattern_name` (required)::
52+
(string) name of the collection of auto-follow patterns
5853

5954
==== Request Body
6055
`leader_cluster`::
@@ -74,7 +69,7 @@ include::../follow-request-body.asciidoc[]
7469

7570
==== Example
7671

77-
The following is an example of using the create auto-follow pattern API.
72+
This example creates an auto-follow pattern named `my_auto_follow_pattern`:
7873

7974
[source,js]
8075
--------------------------------------------------

docs/reference/ccr/apis/follow/get-follow-stats.asciidoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ POST /follower_index/_ccr/pause_follow
4343
GET /_ccr/stats
4444
--------------------------------------------------
4545
// CONSOLE
46-
// TEST
47-
48-
Here, all follower indices will have their follower stats returned.
4946

5047
[source,js]
5148
--------------------------------------------------
@@ -54,8 +51,9 @@ GET /<index>/_ccr/stats
5451
// CONSOLE
5552
// TEST[s/<index>/follower_index/]
5653

57-
Here, `<index>` is a comma-delimited list of index patterns that will be matched
58-
against follower indices to retrieve follower stats for.
54+
==== Path Components
55+
`index` ::
56+
(string) a comma-delimited list of index patterns
5957

6058
==== Results
6159

@@ -181,12 +179,13 @@ Continuing with the fields from `shards`:
181179

182180
==== Example
183181

182+
This example retrieves follower stats:
183+
184184
[source,js]
185185
--------------------------------------------------
186186
GET /_ccr/stats
187187
--------------------------------------------------
188188
// CONSOLE
189-
// TEST
190189

191190
The API returns the following results:
192191
[source,js]

docs/reference/ccr/apis/follow/post-pause-follow.asciidoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,14 @@ POST /<follower_index>/_ccr/pause_follow
4141
// CONSOLE
4242
// TEST[s/<follower_index>/follower_index/]
4343

44-
Here, `<follower_index>` is the name of the follower index to pause.
44+
==== Path Components
45+
46+
`follower_index` (required)::
47+
(string) the name of the follower index
4548

4649
==== Example
4750

48-
The following is an example of using the pause follower API.
51+
This example pauses a follower index named `follower_index`:
4952

5053
[source,js]
5154
--------------------------------------------------

docs/reference/ccr/apis/follow/post-resume-follow.asciidoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,24 @@ POST /<follower_index>/_ccr/resume_follow
5555
// TEST[s/<leader_cluster>/leader_cluster/]
5656
// TEST[s/<leader_index>/leader_index/]
5757

58-
Here, `<follower_index>` is the name of the follower index to resume.
58+
==== Path Components
59+
60+
`follower_index` (required)::
61+
(string) the name of the follower index
5962

6063
==== Request Body
61-
`leader_cluster`::
62-
(required string) the <<modules-remote-clusters,remote cluster>> containing the leader
64+
`leader_cluster` (required)::
65+
(string) the <<modules-remote-clusters,remote cluster>> containing the leader
6366
index
6467

65-
`leader_index`::
66-
(required string) the name of the index in the leader cluster to follow
68+
`leader_index` (required)::
69+
(string) the name of the index in the leader cluster to follow
6770

6871
include::../follow-request-body.asciidoc[]
6972

7073
==== Example
7174

72-
The following is an example of using the resume follower API.
75+
This example resumes a follower index named `follower_index`:
7376

7477
[source,js]
7578
--------------------------------------------------

docs/reference/ccr/apis/follow/post-unfollow.asciidoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,14 @@ POST /<follower_index>/_ccr/unfollow
4848
// CONSOLE
4949
// TEST[s/<follower_index>/follower_index/]
5050

51-
Here, `<follower_index>` is the name of the follower index to convert to a
52-
regular index.
51+
==== Path Components
52+
53+
`follower_index` (required)::
54+
(string) the name of the follower index
5355

5456
==== Example
5557

56-
The following is an example of using the unfollow API.
58+
This example converts `follower_index` from a follower index to a regular index:
5759

5860
[source,js]
5961
--------------------------------------------------

docs/reference/ccr/apis/follow/put-follow.asciidoc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ Creates a follower index.
1212

1313
This API creates a new follower index that is configured to follow the
1414
referenced leader index. When this API returns, the follower index exists, and
15-
{ccr} will start replicating operations from the leader index to the follower
16-
index.
15+
{ccr} starts replicating operations from the leader index to the follower index.
1716

1817
==== Request
1918

@@ -42,24 +41,24 @@ PUT /<follower_index>/_ccr/follow
4241
// TEST[s/<leader_cluster>/leader_cluster/]
4342
// TEST[s/<leader_index>/leader_index/]
4443

45-
Here, `<follower_index>` is the name of the follower index to create,
46-
`<leader_cluster>` is the name of the
47-
<<modules-remote-clusters,remote cluster> containing the leader index, and
48-
`<leader_index>` is the name of the leader index in that remote cluster.
44+
==== Path Components
45+
46+
`follower_index` (required)::
47+
(string) the name of the follower index
4948

5049
==== Request Body
51-
`leader_cluster`::
52-
(required string) the <<modules-remote-clusters,remote cluster>> containing the leader
50+
`leader_cluster` (required)::
51+
(string) the <<modules-remote-clusters,remote cluster>> containing the leader
5352
index
5453

55-
`leader_index`::
56-
(required string) the name of the index in the leader cluster to follow
54+
`leader_index` (required)::
55+
(string) the name of the index in the leader cluster to follow
5756

5857
include::../follow-request-body.asciidoc[]
5958

6059
==== Example
6160

62-
The following is an example of using the create follower API.
61+
This example creates a follower index named `follower_index`:
6362

6463
[source,js]
6564
--------------------------------------------------

0 commit comments

Comments
 (0)