Merge branch 'fix/watcher-email-tests-pre-2.3' into 2.x

Author: russcam

src/Nest/Nest.csproj

@@ -1265,6 +1265,7 @@
     <Compile Include="XPack\Watcher\Action\ActionBase.cs" />
     <Compile Include="XPack\Watcher\Action\ActionsDescriptorBase.cs" />
     <Compile Include="XPack\Watcher\Action\ActionType.cs" />
+    <Compile Include="XPack\Watcher\Action\Email\AttachData.cs" />
     <Compile Include="XPack\Watcher\Action\Email\DataAttachment.cs" />
     <Compile Include="XPack\Watcher\Action\Email\EmailAction.cs" />
     <Compile Include="XPack\Watcher\Action\Email\EmailAttachments.cs" />

src/Nest/XPack/Watcher/Action/Actions.cs

@@ -74,6 +74,10 @@ public ActionsDescriptor() : base(new Actions())
 		{
 		}
 
+		/// <summary>
+		/// A watch action that sends email notifications.
+		/// To use the email action, you must configure at least one email account.
+		/// </summary>
 		public ActionsDescriptor Email(string name, Func<EmailActionDescriptor, IEmailAction> selector) =>
 			Assign(name, selector.InvokeOrDefault(new EmailActionDescriptor(name)));
 
@@ -86,6 +90,13 @@ public ActionsDescriptor Index(string name, Func<IndexActionDescriptor, IIndexAc
 		public ActionsDescriptor Logging(string name, Func<LoggingActionDescriptor, ILoggingAction> selector) =>
 			Assign(name, selector.InvokeOrDefault(new LoggingActionDescriptor(name)));
 
+		/// <summary>
+		/// A watch action that creates events in PagerDuty.
+		/// To use the PagerDuty action, you need to configure at least one PagerDuty account in Watcher.
+		/// </summary>
+		/// <remarks>
+		/// Only available in Watcher 2.3 and up
+		/// </remarks>
 		public ActionsDescriptor PagerDuty(string name, Func<PagerDutyActionDescriptor, IPagerDutyAction> selector) =>
 			Assign(name, selector.InvokeOrDefault(new PagerDutyActionDescriptor(name)));
 

src/Nest/XPack/Watcher/Action/Email/AttachData.cs

@@ -0,0 +1,11 @@
+using Newtonsoft.Json;
+
+namespace Nest
+{
+	[JsonObject]
+	public class AttachData
+	{
+		[JsonProperty("format")]
+		public DataAttachmentFormat Format { get; set; }
+	}
+}

src/Nest/XPack/Watcher/Action/Email/EmailAction.cs

@@ -4,6 +4,10 @@
 
 namespace Nest
 {
+	/// <summary>
+	/// A watch action that sends email notifications.
+	/// To use the email action, you must configure at least one email account.
+	/// </summary>
 	[JsonObject]
 	public interface IEmailAction : IAction
 	{
@@ -36,8 +40,16 @@ public interface IEmailAction : IAction
 
 		[JsonProperty("attachments")]
 		IEmailAttachments Attachments { get; set; }
+
+		[JsonProperty("attach_data")]
+		[Obsolete("Deprecated in Watcher 2.3. Use Attachments to set Attachment data")]
+		Union<bool?, AttachData> AttachData { get; set; }
 	}
 
+	/// <summary>
+	/// A watch action that sends email notifications.
+	/// To use the email action, you must configure at least one email account.
+	/// </summary>
 	public class EmailAction : ActionBase, IEmailAction
 	{
 		public override ActionType ActionType => ActionType.Email;
@@ -62,9 +74,28 @@ public EmailAction(string name) : base(name) {}
 
 		public EmailPriority? Priority { get; set; }
 
+		/// <summary>
+		/// Attaches an attachment to the email
+		/// </summary>
+		/// <remarks>
+		/// Only available in Watcher 2.3 and up
+		/// </remarks>
 		public IEmailAttachments Attachments { get; set; }
+
+		/// <summary>
+		/// Indicates whether the watch execution data should be attached to the email.
+		/// If set to <c>true</c>, the data is attached as a YAML file called data.yml.
+		/// If it’s set to <c>false</c>, no data is attached.
+		/// To attach data and control the format of the attached data, assign <see cref="AttachData"/>
+		/// </summary>
+		[Obsolete("Deprecated in Watcher 2.3. Use Attachments to set Attachment data")]
+		public Union<bool?, AttachData> AttachData { get; set; }
 	}
 
+	/// <summary>
+	/// A watch action that sends email notifications.
+	/// To use the email action, you must configure at least one email account.
+	/// </summary>
 	public class EmailActionDescriptor : ActionsDescriptorBase<EmailActionDescriptor, IEmailAction>, IEmailAction
 	{
 		public EmailActionDescriptor(string name) : base(name) {}
@@ -81,6 +112,7 @@ public EmailActionDescriptor(string name) : base(name) {}
 		IEmailBody IEmailAction.Body { get; set; }
 		EmailPriority? IEmailAction.Priority { get; set; }
 		IEmailAttachments IEmailAction.Attachments { get; set; }
+		Union<bool?, AttachData> IEmailAction.AttachData { get; set; }
 
 		public EmailActionDescriptor Account(string account) => Assign(a => a.Account = account);
 
@@ -109,7 +141,27 @@ public EmailActionDescriptor Body(Func<EmailBodyDescriptor, IEmailBody> selector
 
 		public EmailActionDescriptor Priority(EmailPriority priority) => Assign(a => a.Priority = priority);
 
+		/// <summary>
+		/// Attach an attachment to the email, only available since watcher 2.3 and up.
+		/// </summary>
 		public EmailActionDescriptor Attachments(Func<EmailAttachmentsDescriptor, IPromise<IEmailAttachments>> selector) =>
 			Assign(a => a.Attachments = selector?.Invoke(new EmailAttachmentsDescriptor())?.Value);
+
+		/// <summary>
+		/// Indicates whether the watch execution data should be attached to the email.
+		/// If set to <c>true</c>, the data is attached as a YAML file called data.yml.
+		/// If it’s set to <c>false</c>, no data is attached.
+		/// To attach data and control the format of the attached data, use <see cref="AttachData(DataAttachmentFormat)"/>
+		/// </summary>
+		[Obsolete("Deprecated in Watcher 2.3. Use Attachments to set Attachment data")]
+		public EmailActionDescriptor AttachData(bool attach = true) =>
+			Assign(a => a.AttachData = attach);
+
+		/// <summary>
+		/// Indicates to attach the watch execution data attached to the email and the format.
+		/// </summary>
+		[Obsolete("Deprecated in Watcher 2.3. Use Attachments to set Attachment data")]
+		public EmailActionDescriptor AttachData(DataAttachmentFormat format) =>
+			Assign(a => a.AttachData = new AttachData { Format = format });
 	}
 }

src/Nest/XPack/Watcher/Action/PagerDuty/PagerDutyAction.cs

@@ -6,11 +6,25 @@
 
 namespace Nest
 {
+	/// <summary>
+	/// A watch action that creates events in PagerDuty.
+	/// To use the PagerDuty action, you need to configure at least one PagerDuty account in Watcher.
+	/// </summary>
+	/// <remarks>
+	/// Only available in Watcher 2.3 and up
+	/// </remarks>
 	[JsonObject]
 	public interface IPagerDutyAction : IAction, IPagerDutyEvent
 	{
 	}
 
+	/// <summary>
+	/// A watch action that creates events in PagerDuty.
+	/// To use the PagerDuty action, you need to configure at least one PagerDuty account in Watcher.
+	/// </summary>
+	/// <remarks>
+	/// Only available in Watcher 2.3 and up
+	/// </remarks>
 	public class PagerDutyAction : ActionBase, IPagerDutyAction
 	{
 		public override ActionType ActionType => ActionType.PagerDuty;
@@ -36,6 +50,13 @@ public PagerDutyAction(string name) : base(name)
 		}
 	}
 
+	/// <summary>
+	/// A watch action that creates events in PagerDuty.
+	/// To use the PagerDuty action, you need to configure at least one PagerDuty account in Watcher.
+	/// </summary>
+	/// <remarks>
+	/// Only available in Watcher 2.3 and up
+	/// </remarks>
 	public class PagerDutyActionDescriptor : ActionsDescriptorBase<PagerDutyActionDescriptor, IPagerDutyAction>, IPagerDutyAction
 	{
 		protected override ActionType ActionType => ActionType.PagerDuty;

src/Nest/XPack/Watcher/Input/ChainInput.cs

@@ -7,6 +7,9 @@ namespace Nest
 	/// <summary>
 	///  input to load data from multiple sources into the watch execution context when the watch is triggered.
 	/// </summary>
+	/// <remarks>
+	/// Only available in Watcher 2.1 onwards
+	/// </remarks>
 	[JsonObject]
 	[JsonConverter(typeof(ChainInputJsonConverter))]
 	public interface IChainInput : IInput
@@ -17,7 +20,12 @@ public interface IChainInput : IInput
 		IDictionary<string, InputContainer> Inputs { get; set; }
 	}
 
-	/// <inheritdoc />
+	/// <summary>
+	///  input to load data from multiple sources into the watch execution context when the watch is triggered.
+	/// </summary>
+	/// <remarks>
+	/// Only available in Watcher 2.1 onwards
+	/// </remarks>
 	public class ChainInput : InputBase, IChainInput
 	{
 		public ChainInput() {}
@@ -33,7 +41,12 @@ public ChainInput(IDictionary<string, InputContainer> inputs)
 		internal override void WrapInContainer(IInputContainer container) => container.Chain = this;
 	}
 
-	/// <inheritdoc />
+	/// <summary>
+	///  input to load data from multiple sources into the watch execution context when the watch is triggered.
+	/// </summary>
+	/// <remarks>
+	/// Only available in Watcher 2.1 onwards
+	/// </remarks>
 	public class ChainInputDescriptor : DescriptorBase<ChainInputDescriptor, IChainInput>, IChainInput
 	{
 		public ChainInputDescriptor() {}

src/Nest/XPack/Watcher/Input/InputContainer.cs

@@ -16,6 +16,12 @@ public interface IInputContainer
 		[JsonProperty("simple")]
 		ISimpleInput Simple { get; set; }
 
+		/// <summary>
+		///  input to load data from multiple sources into the watch execution context when the watch is triggered.
+		/// </summary>
+		/// <remarks>
+		/// Only available in Watcher 2.1 onwards
+		/// </remarks>
 		[JsonProperty("chain")]
 		IChainInput Chain { get; set; }
 	}
@@ -54,6 +60,12 @@ public InputDescriptor Http(Func<HttpInputDescriptor, IHttpInput> selector) =>
 		public InputDescriptor Simple(Func<SimpleInputDescriptor, ISimpleInput> selector) =>
 			Assign(a => a.Simple = selector.Invoke(new SimpleInputDescriptor()));
 
+		/// <summary>
+		///  input to load data from multiple sources into the watch execution context when the watch is triggered.
+		/// </summary>
+		/// <remarks>
+		/// Only available in Watcher 2.1 onwards
+		/// </remarks>
 		public InputDescriptor Chain(Func<ChainInputDescriptor, IChainInput> selector) =>
 			Assign(a => a.Chain = selector.Invoke(new ChainInputDescriptor()));
 	}

src/Tests/XPack/Watcher/ExecuteWatch/ExecuteWatchApiTests.cs

@@ -11,6 +11,7 @@
 
 namespace Tests.XPack.Watcher.ExecuteWatch
 {
+	[SkipVersion("<2.3.0", "Email action has no attachments and pagerduty action does not exist in these versions")]
 	public class ExecuteWatchApiTests : ApiIntegrationTestBase<XPackCluster, IExecuteWatchResponse, IExecuteWatchRequest, ExecuteWatchDescriptor, ExecuteWatchRequest>
 	{
 		private readonly DateTimeOffset _triggeredDateTime = new DateTimeOffset(2016, 11, 17, 13, 00, 00, TimeSpan.Zero);