This API comments

Mpdreamz · Mpdreamz · commit fcda8320ba3d · 2019-01-25T12:00:43.000+01:00
diff --git a/src/Nest/Cluster/ClusterSettings/ClusterPutSettings/RemoteClusterConfiguration.cs b/src/Nest/Cluster/ClusterSettings/ClusterPutSettings/RemoteClusterConfiguration.cs
@@ -5,8 +5,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// This is a custom dictionary that helps in the creation of remote cluster configuration
-	/// you can pass to the Put Cluster Settings API
+	/// Simplifies the creation of remote cluster configuration, can be combined with a dictionary using the overloaded + operator
 	/// </summary>
 	public class RemoteClusterConfiguration : IsADictionaryBase<string, object>
 	{
diff --git a/src/Nest/XPack/CrossClusterReplication/AutoFollow/CreateAutoFollowPattern/CreateAutoFollowPatternRequest.cs b/src/Nest/XPack/CrossClusterReplication/AutoFollow/CreateAutoFollowPattern/CreateAutoFollowPatternRequest.cs
@@ -4,7 +4,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// This API creates a new named collection of auto-follow patterns against the remote cluster specified
+	/// Creates a new named collection of auto-follow patterns against the remote cluster specified
 	/// in the request body. Newly created indices on the remote cluster matching any of the specified patterns
 	/// will be automatically configured as follower indices.
 	/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/AutoFollow/CreateAutoFollowPattern/ElasticClient-CreateAutoFollowPattern.cs b/src/Nest/XPack/CrossClusterReplication/AutoFollow/CreateAutoFollowPattern/ElasticClient-CreateAutoFollowPattern.cs
@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// This API creates a new named collection of auto-follow patterns against the remote cluster specified
+		/// Creates a new named collection of auto-follow patterns against the remote cluster specified
 		/// in the request body. Newly created indices on the remote cluster matching any of the specified patterns
 		/// will be automatically configured as follower indices.
 		/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/AutoFollow/DeleteAutoFollowPattern/DeleteAutoFollowPatternRequest.cs b/src/Nest/XPack/CrossClusterReplication/AutoFollow/DeleteAutoFollowPattern/DeleteAutoFollowPatternRequest.cs
@@ -3,7 +3,7 @@
 
 namespace Nest
 {
-	/// <summary> This API deletes a configured collection of auto-follow patterns. </summary>
+	/// <summary> Deletes a configured collection of auto-follow patterns. </summary>
 	[MapsApi("ccr.delete_auto_follow_pattern.json")]
 	[ContractJsonConverter(typeof(ReadAsTypeJsonConverter<DeleteAutoFollowPatternRequest>))]
 	public partial interface IDeleteAutoFollowPatternRequest { }
diff --git a/src/Nest/XPack/CrossClusterReplication/AutoFollow/DeleteAutoFollowPattern/ElasticClient-DeleteAutoFollowPattern.cs b/src/Nest/XPack/CrossClusterReplication/AutoFollow/DeleteAutoFollowPattern/ElasticClient-DeleteAutoFollowPattern.cs
@@ -7,7 +7,7 @@ namespace Nest
 {
 	public partial interface IElasticClient
 	{
-		/// <summary>This API deletes a configured collection of auto-follow patterns.</summary>
+		/// <summary>Deletes a configured collection of auto-follow patterns.</summary>
 		IDeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Name name, Func<DeleteAutoFollowPatternDescriptor, IDeleteAutoFollowPatternRequest> selector = null);
 
 		/// <inheritdoc cref="DeleteAutoFollowPattern(Name,System.Func{Nest.DeleteAutoFollowPatternDescriptor,Nest.IDeleteAutoFollowPatternRequest})" />
diff --git a/src/Nest/XPack/CrossClusterReplication/AutoFollow/GetAutoFollowPattern/ElasticClient-GetAutoFollowPattern.cs b/src/Nest/XPack/CrossClusterReplication/AutoFollow/GetAutoFollowPattern/ElasticClient-GetAutoFollowPattern.cs
@@ -7,7 +7,7 @@ namespace Nest
 {
 	public partial interface IElasticClient
 	{
-		/// <summary> This API gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection. </summary>
+		/// <summary> Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. </summary>
 		IGetAutoFollowPatternResponse GetAutoFollowPattern(Func<GetAutoFollowPatternDescriptor, IGetAutoFollowPatternRequest> selector = null);
 
 		/// <inheritdoc cref="GetAutoFollowPattern(System.Func{Nest.GetAutoFollowPatternDescriptor,Nest.IGetAutoFollowPatternRequest})" />
diff --git a/src/Nest/XPack/CrossClusterReplication/AutoFollow/GetAutoFollowPattern/GetAutoFollowPatternRequest.cs b/src/Nest/XPack/CrossClusterReplication/AutoFollow/GetAutoFollowPattern/GetAutoFollowPatternRequest.cs
@@ -3,7 +3,7 @@
 
 namespace Nest
 {
-	/// <summary> This API gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection. </summary>
+	/// <summary> Gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection. </summary>
 	[MapsApi("ccr.get_auto_follow_pattern.json")]
 	[ContractJsonConverter(typeof(ReadAsTypeJsonConverter<GetAutoFollowPatternRequest>))]
 	public partial interface IGetAutoFollowPatternRequest { }
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/CreateFollowIndex/CreateFollowIndexRequest.cs b/src/Nest/XPack/CrossClusterReplication/Follow/CreateFollowIndex/CreateFollowIndexRequest.cs
@@ -5,7 +5,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// This API creates a new follower index that is configured to follow the referenced leader index.
+	/// Creates a new follower index that is configured to follow the referenced leader index.
 	/// When this API returns, the follower index exists, and cross-cluster replication starts replicating operations
 	/// from the leader index to the follower index
 	/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/CreateFollowIndex/ElasticClient-CreateFollowIndex.cs b/src/Nest/XPack/CrossClusterReplication/Follow/CreateFollowIndex/ElasticClient-CreateFollowIndex.cs
@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// This API creates a new follower index that is configured to follow the referenced leader index.
+		/// Creates a new follower index that is configured to follow the referenced leader index.
 		/// When this API returns, the follower index exists, and cross-cluster replication starts replicating
 		/// operations from the leader index to the follower index.
 		/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/FollowIndexStats/ElasticClient-FollowIndexStats.cs b/src/Nest/XPack/CrossClusterReplication/Follow/FollowIndexStats/ElasticClient-FollowIndexStats.cs
@@ -8,8 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// This API gets follower stats. This API will return shard-level stats about the
-		/// following tasks associated with each shard for the specified indices.
+		/// Gets follower stats. Returns shard-level stats about the following tasks associated with each shard for the specified indices.
 		/// </summary>
 		IFollowIndexStatsResponse FollowIndexStats(Indices indices, Func<FollowIndexStatsDescriptor, IFollowIndexStatsRequest> selector = null);
 
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/FollowIndexStats/FollowIndexStatsRequest.cs b/src/Nest/XPack/CrossClusterReplication/Follow/FollowIndexStats/FollowIndexStatsRequest.cs
@@ -1,19 +1,16 @@
-﻿using System;
-using Newtonsoft.Json;
-
-namespace Nest
+﻿namespace Nest
 {
 	/// <summary>
-	/// This API gets follower stats. This API will return shard-level stats about the following tasks
-	/// associated with each shard for the specified indices.
+	/// Gets follower stats. Will return shard-level stats about the following tasks associated with each shard for the
+	/// specified indices.
 	/// </summary>
 	[MapsApi("ccr.follow_stats.json")]
 	[ContractJsonConverter(typeof(ReadAsTypeJsonConverter<FollowIndexStatsRequest>))]
 	public partial interface IFollowIndexStatsRequest { }
 
-	/// <inheritdoc cref="IFollowIndexStatsRequest"/>
+	/// <inheritdoc cref="IFollowIndexStatsRequest" />
 	public partial class FollowIndexStatsRequest { }
 
-	/// <inheritdoc cref="IFollowIndexStatsRequest"/>
+	/// <inheritdoc cref="IFollowIndexStatsRequest" />
 	public partial class FollowIndexStatsDescriptor { }
 }
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/PauseFollowIndex/ElasticClient-PauseFollowIndex.cs b/src/Nest/XPack/CrossClusterReplication/Follow/PauseFollowIndex/ElasticClient-PauseFollowIndex.cs
@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// This API pauses a follower index. When this API returns, the follower index will not fetch any additional operations from
+		/// Pauses a follower index. When this API returns, the follower index will not fetch any additional operations from
 		/// the leader index. You can resume following with the resume follower API. Pausing and resuming a follower index can be
 		/// used to change the configuration of the following task.
 		/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/PauseFollowIndex/PauseFollowIndexRequest.cs b/src/Nest/XPack/CrossClusterReplication/Follow/PauseFollowIndex/PauseFollowIndexRequest.cs
@@ -4,7 +4,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// This API pauses a follower index. When this API returns, the follower index will not fetch any additional operations from
+	/// Pauses a follower index. When this API returns, the follower index will not fetch any additional operations from
 	/// the leader index. You can resume following with the resume follower API. Pausing and resuming a follower index can be
 	/// used to change the configuration of the following task.
 	/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/ResumeFollowIndex/ElasticClient-ResumeFollowIndex.cs b/src/Nest/XPack/CrossClusterReplication/Follow/ResumeFollowIndex/ElasticClient-ResumeFollowIndex.cs
@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// This API resumes a follower index that has been paused either explicitly with the pause follower API or
+		/// Resumes a follower index that has been paused either explicitly with the pause follower API or
 		/// implicitly due to execution that can not be retried due to failure during following. When this API returns,
 		/// the follower index will resume fetching operations from the leader index.
 		/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/ResumeFollowIndex/ResumeFollowIndexRequest.cs b/src/Nest/XPack/CrossClusterReplication/Follow/ResumeFollowIndex/ResumeFollowIndexRequest.cs
@@ -4,7 +4,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// This API resumes a follower index that has been paused either explicitly with the pause follower API or
+	/// Resumes a follower index that has been paused either explicitly with the pause follower API or
 	/// implicitly due to execution that can not be retried due to failure during following. When this API returns,
 	/// the follower index will resume fetching operations from the leader index.
 	/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/UnfollowIndex/ElasticClient-UnfollowIndex.cs b/src/Nest/XPack/CrossClusterReplication/Follow/UnfollowIndex/ElasticClient-UnfollowIndex.cs
@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// This API stops the following task associated with a follower index and removes index metadata and settings associated with
+		/// Stops the following task associated with a follower index and removes index metadata and settings associated with
 		/// cross-cluster replication. This enables the index to treated as a regular index. The follower index must be paused and closed
 		/// before invoking the unfollow API.
 		/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Follow/UnfollowIndex/UnfollowIndexRequest.cs b/src/Nest/XPack/CrossClusterReplication/Follow/UnfollowIndex/UnfollowIndexRequest.cs
@@ -4,7 +4,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// This API stops the following task associated with a follower index and removes index metadata and settings associated with
+	/// Stops the following task associated with a follower index and removes index metadata and settings associated with
 	/// cross-cluster replication. This enables the index to treated as a regular index. The follower index must be paused and closed
 	/// before invoking the unfollow API.
 	/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Stats/CcrStatsRequest.cs b/src/Nest/XPack/CrossClusterReplication/Stats/CcrStatsRequest.cs
@@ -4,7 +4,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// This API gets cross-cluster replication stats. This API will return all stats related to cross-cluster replication.
+	/// Gets cross-cluster replication stats. Returns all stats related to cross-cluster replication.
 	/// In particular, this API returns stats about auto-following, and returns the same shard-level stats as in the get
 	/// follower stats API. <see cref="IElasticClient.FollowIndexStats(Nest.Indices,System.Func{Nest.FollowIndexStatsDescriptor,Nest.IFollowIndexStatsRequest})"/>
 	/// </summary>
diff --git a/src/Nest/XPack/CrossClusterReplication/Stats/ElasticClient-CcrStats.cs b/src/Nest/XPack/CrossClusterReplication/Stats/ElasticClient-CcrStats.cs
@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// This API gets cross-cluster replication stats. This API will return all stats related to cross-cluster replication.
+		/// Gets cross-cluster replication stats. This API will return all stats related to cross-cluster replication.
 		/// In particular, this API returns stats about auto-following, and returns the same shard-level stats as in the get
 		/// follower stats API. <see cref="IElasticClient.FollowIndexStats(Nest.Indices,System.Func{Nest.FollowIndexStatsDescriptor,Nest.IFollowIndexStatsRequest})"/>
 		/// </summary>

Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,7 @@`
`5`	`5`	`namespace Nest`
`6`	`6`	`{`
`7`	`7`	`/// <summary>`
`8`		`- /// This is a custom dictionary that helps in the creation of remote cluster configuration`
`9`		`- /// you can pass to the Put Cluster Settings API`
	`8`	`+ /// Simplifies the creation of remote cluster configuration, can be combined with a dictionary using the overloaded + operator`
`10`	`9`	`/// </summary>`
`11`	`10`	`public class RemoteClusterConfiguration : IsADictionaryBase<string, object>`
`12`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`namespace Nest`
`5`	`5`	`{`
`6`	`6`	`/// <summary>`
`7`		`- /// This API creates a new named collection of auto-follow patterns against the remote cluster specified`
	`7`	`+ /// Creates a new named collection of auto-follow patterns against the remote cluster specified`
`8`	`8`	`/// in the request body. Newly created indices on the remote cluster matching any of the specified patterns`
`9`	`9`	`/// will be automatically configured as follower indices.`
`10`	`10`	`/// </summary>`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace Nest`
`8`	`8`	`public partial interface IElasticClient`
`9`	`9`	`{`
`10`	`10`	`/// <summary>`
`11`		`- /// This API creates a new named collection of auto-follow patterns against the remote cluster specified`
	`11`	`+ /// Creates a new named collection of auto-follow patterns against the remote cluster specified`
`12`	`12`	`/// in the request body. Newly created indices on the remote cluster matching any of the specified patterns`
`13`	`13`	`/// will be automatically configured as follower indices.`
`14`	`14`	`/// </summary>`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace Nest`
`5`	`5`	`{`
`6`		`- /// <summary> This API deletes a configured collection of auto-follow patterns. </summary>`
	`6`	`+ /// <summary> Deletes a configured collection of auto-follow patterns. </summary>`
`7`	`7`	`[MapsApi("ccr.delete_auto_follow_pattern.json")]`
`8`	`8`	`[ContractJsonConverter(typeof(ReadAsTypeJsonConverter<DeleteAutoFollowPatternRequest>))]`
`9`	`9`	`public partial interface IDeleteAutoFollowPatternRequest { }`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace Nest`
`7`	`7`	`{`
`8`	`8`	`public partial interface IElasticClient`
`9`	`9`	`{`
`10`		`- /// <summary>This API deletes a configured collection of auto-follow patterns.</summary>`
	`10`	`+ /// <summary>Deletes a configured collection of auto-follow patterns.</summary>`
`11`	`11`	`IDeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Name name, Func<DeleteAutoFollowPatternDescriptor, IDeleteAutoFollowPatternRequest> selector = null);`
`12`	`12`
`13`	`13`	`/// <inheritdoc cref="DeleteAutoFollowPattern(Name,System.Func{Nest.DeleteAutoFollowPatternDescriptor,Nest.IDeleteAutoFollowPatternRequest})" />`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace Nest`
`5`	`5`	`{`
`6`		`- /// <summary> This API gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection. </summary>`
	`6`	`+ /// <summary> Gets configured auto-follow patterns. This API will return the specified auto-follow pattern collection. </summary>`
`7`	`7`	`[MapsApi("ccr.get_auto_follow_pattern.json")]`
`8`	`8`	`[ContractJsonConverter(typeof(ReadAsTypeJsonConverter<GetAutoFollowPatternRequest>))]`
`9`	`9`	`public partial interface IGetAutoFollowPatternRequest { }`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Nest`
`6`	`6`	`{`
`7`	`7`	`/// <summary>`
`8`		`- /// This API creates a new follower index that is configured to follow the referenced leader index.`
	`8`	`+ /// Creates a new follower index that is configured to follow the referenced leader index.`
`9`	`9`	`/// When this API returns, the follower index exists, and cross-cluster replication starts replicating operations`
`10`	`10`	`/// from the leader index to the follower index`
`11`	`11`	`/// </summary>`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,7 @@ namespace Nest`
`8`	`8`	`public partial interface IElasticClient`
`9`	`9`	`{`
`10`	`10`	`/// <summary>`
`11`		`- /// This API gets follower stats. This API will return shard-level stats about the`
`12`		`- /// following tasks associated with each shard for the specified indices.`
	`11`	`+ /// Gets follower stats. Returns shard-level stats about the following tasks associated with each shard for the specified indices.`
`13`	`12`	`/// </summary>`
`14`	`13`	`IFollowIndexStatsResponse FollowIndexStats(Indices indices, Func<FollowIndexStatsDescriptor, IFollowIndexStatsRequest> selector = null);`
`15`	`14`