Added xml doc to request messages

SkylineCommunications · Jul 6, 2023 · cc11e0b · cc11e0b
1 parent 929c60a
commit cc11e0b
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 0 deletions.
diff --git a/...s.ConnectorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/EthThresholds/Messages.cs b/...s.ConnectorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/EthThresholds/Messages.cs
@@ -4,6 +4,9 @@
 
 	using Skyline.DataMiner.Core.InterAppCalls.Common.CallSingle;
 
+	/// <summary>
+	/// Inter-App Message allowing to add new entries to the Ethernet Thresholds table.
+	/// </summary>
 	public class CreateEthThreshold : Message
 	{
 		public EthThresholdData ThresholdData { get; set; }
@@ -24,6 +27,9 @@ public class CreateEthThresholdResult : Message
 		public string ThresholdID { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to edit existing entries from the Ethernet Thresholds table.
+	/// </summary>
 	public class EditEthThreshold : Message
 	{
 		public string ThresholdToUpdateName { get; set; }
@@ -46,6 +52,9 @@ public class EditEthThresholdResult : Message
 		public string ThresholdId { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to delete existing entries from the Ethernet Thresholds table.
+	/// </summary>
 	public class DeleteEthThresholds : Message
 	{
 		public IEnumerable<string> ThresholdToDeleteNames { get; set; }

diff --git a/...s.ConnectorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/EtrThresholds/Messages.cs b/...s.ConnectorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/EtrThresholds/Messages.cs
@@ -4,6 +4,9 @@
 
 	using Skyline.DataMiner.Core.InterAppCalls.Common.CallSingle;
 
+	/// <summary>
+	/// Inter-App Message allowing to add new entries to the ETR Thresholds table.
+	/// </summary>
 	public class CreateEtrThreshold : Message
 	{
 		public EtrThresholdData ThresholdData { get; set; }
@@ -24,6 +27,9 @@ public class CreateEtrThresholdResult : Message
 		public string ThresholdID { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to edit existing entries from the ETR Thresholds table.
+	/// </summary>
 	public class EditEtrThreshold : Message
 	{
 		public string ThresholdToUpdateName { get; set; }
@@ -46,6 +52,9 @@ public class EditEtrThresholdResult : Message
 		public string ThresholdId { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to delete existing entries from the ETR Thresholds table.
+	/// </summary>
 	public class DeleteEtrThresholds : Message
 	{
 		public IEnumerable<string> ThresholdToDeleteNames { get; set; }

diff --git a/...s.ConnectorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/PidThresholds/Messages.cs b/...s.ConnectorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/PidThresholds/Messages.cs
@@ -4,6 +4,9 @@
 
 	using Skyline.DataMiner.Core.InterAppCalls.Common.CallSingle;
 
+	/// <summary>
+	/// Inter-App Message allowing to add new entries to the PID Thresholds table.
+	/// </summary>
 	public class CreatePidThreshold : Message
 	{
 		public PidThresholdData ThresholdData { get; set; }
@@ -24,6 +27,9 @@ public class CreatePidThresholdResult : Message
 		public string ThresholdID { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to edit existing entries from the PID Thresholds table.
+	/// </summary>
 	public class EditPidThreshold : Message
 	{
 		public string ThresholdToUpdateName { get; set; }
@@ -46,6 +52,9 @@ public class EditPidThresholdResult : Message
 		public string ThresholdId { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to delete existing entries from the PID Thresholds table.
+	/// </summary>
 	public class DeletePidThresholds : Message
 	{
 		public IEnumerable<string> ThresholdToDeleteNames { get; set; }

diff --git a/...ctorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/PidThresholdsPresets/Messages.cs b/...ctorAPI.BridgeTechnologies.VBProbeSeries/AlarmThresholds/PidThresholdsPresets/Messages.cs
@@ -4,6 +4,9 @@
 
 	using Skyline.DataMiner.Core.InterAppCalls.Common.CallSingle;
 
+	/// <summary>
+	/// Inter-App Message allowing to add new entries to the PID Threshold Presets table.
+	/// </summary>
 	public class CreatePidThresholdPreset : Message
 	{
 		public string ThresholdName { get; set; }
@@ -27,6 +30,9 @@ public class CreatePidThresholdPresetResult : Message
 		////public string ThresholdID { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to edit existing entries from the PID Threshold Presets table.
+	/// </summary>
 	public class EditPidThresholdPreset : Message
 	{
 		/// <summary>
@@ -74,6 +80,9 @@ public class EditPidThresholdPresetResult : Message
 		public string ThresholdPresetKey { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to delete existing entries from the PID Threshold Presets table.
+	/// </summary>
 	public class DeletePidThresholdPreset : Message
 	{
 		/// <summary>

diff --git a/Utils.ConnectorAPI.BridgeTechnologies.VBProbeSeries/Ethernet/Messages.cs b/Utils.ConnectorAPI.BridgeTechnologies.VBProbeSeries/Ethernet/Messages.cs
@@ -4,6 +4,9 @@
 
 	using Skyline.DataMiner.Core.InterAppCalls.Common.CallSingle;
 
+	/// <summary>
+	/// Inter-App Message allowing to add new entries to the Ethernet Available Streams table.
+	/// </summary>
 	public class CreateEthStream : Message
 	{
 		public EthStreamData StreamData { get; set; }
@@ -26,6 +29,9 @@ public class CreateEthStreamResult : Message
 		public int StreamID { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to edit existing entries from the Ethernet Available Streams table.
+	/// </summary>
 	public class EditEthStream : Message
 	{
 		public string Key { get; set; }
@@ -48,6 +54,9 @@ public class EditEthStreamResult : Message
 		public string StreamKey { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to delete existing entries from the Ethernet Available Streams table.
+	/// </summary>
 	public class DeleteEthStreams : Message
 	{
 		public string[] StreamKeys { get; set; }

diff --git a/Utils.ConnectorAPI.BridgeTechnologies.VBProbeSeries/OTT/Messages.cs b/Utils.ConnectorAPI.BridgeTechnologies.VBProbeSeries/OTT/Messages.cs
@@ -4,6 +4,9 @@
 
 	using Skyline.DataMiner.Core.InterAppCalls.Common.CallSingle;
 
+	/// <summary>
+	/// Inter-App Message allowing to add new entries to the OTT Available Channels table.
+	/// </summary>
 	public class CreateOttChannel : Message
 	{
 		public OttChannelData ChannelData { get; set; }
@@ -24,6 +27,9 @@ public class CreateOttChannelResult : Message
 		public string ChannelId { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to edit existing entries from the OTT Available Channels table.
+	/// </summary>
 	public class EditOttChannel : Message
 	{
 		public string ChannelId { get; set; }
@@ -46,6 +52,9 @@ public class EditOttChannelResult : Message
 		public string ChannelId { get; set; }
 	}
 
+	/// <summary>
+	/// Inter-App Message allowing to delete existing entries from the OTT Available Channels table.
+	/// </summary>
 	public class DeleteOttChannels : Message
 	{
 		public string[] ChannelIds { get; set; }