From a9bbcd1e29ff8641051534455368ceaa76a498da Mon Sep 17 00:00:00 2001
From: Stijn Moreels <9039753+stijnmoreels@users.noreply.github.com>
Date: Thu, 5 May 2022 12:18:48 +0200
Subject: [PATCH] chore: add remarks for az app dto (#134)

---
 .../AzureApplication.cs                                   | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/Arcus.BackgroundJobs.AzureActiveDirectory/AzureApplication.cs b/src/Arcus.BackgroundJobs.AzureActiveDirectory/AzureApplication.cs
index bfc4536..d15d70c 100644
--- a/src/Arcus.BackgroundJobs.AzureActiveDirectory/AzureApplication.cs
+++ b/src/Arcus.BackgroundJobs.AzureActiveDirectory/AzureApplication.cs
@@ -4,7 +4,11 @@
 namespace Arcus.BackgroundJobs.AzureActiveDirectory
 {
     /// <summary>
-    /// Represents an <see cref="AzureApplication"/> from Azure Active Directory.
+    /// Represents an application running on Azure, in an Azure Active Directory.
+    /// <remarks>
+    ///     This model is used to publicly represent the client applications and is used during event tracking.
+    ///     Therefore, new values added here should be carefully considered as all data represented here is made public in the configured logging system.
+    /// </remarks>
     /// </summary>
     public class AzureApplication
     {
@@ -18,7 +22,7 @@ public class AzureApplication
         /// <exception cref="ArgumentException">Thrown when the <paramref name="name"/> is blank.</exception>
         public AzureApplication(string name, Guid? keyId, DateTimeOffset? endDateTime, double remainingValidDays)
         {
-            Guard.NotNullOrWhitespace(name, nameof(name));
+            Guard.NotNullOrWhitespace(name, nameof(name), "Requires a name to describe the application running on Azure");
 
             Name = name;
             KeyId = keyId;