feat: !WIP add summaries to config keys

1 files changed, 92 insertions, 51 deletions

diff --git a/code/api/src/Data/Models/AppConfiguration.cs b/code/api/src/Data/Models/AppConfiguration.cs
index 6bd93d0..0f720ce 100644
--- a/code/api/src/Data/Models/AppConfiguration.cs
+++ b/code/api/src/Data/Models/AppConfiguration.cs
@@ -4,58 +4,99 @@ namespace IOL.GreatOffice.Api.Data.Models;
 
 public class AppConfiguration
 {
-	public string DB_HOST { get; set; }
-	public string DB_PORT { get; set; }
-	public string DB_USER { get; set; }
-	public string DB_PASSWORD { get; set; }
-	public string DB_NAME { get; set; }
-	public string QUARTZ_DB_HOST { get; set; }
-	public string QUARTZ_DB_PORT { get; set; }
-	public string QUARTZ_DB_USER { get; set; }
-	public string QUARTZ_DB_PASSWORD { get; set; }
-	public string QUARTZ_DB_NAME { get; set; }
-	public string SEQ_API_KEY { get; set; }
-	public string SEQ_API_URL { get; set; }
-	public string SMTP_HOST { get; set; }
-	public string SMTP_PORT { get; set; }
-	public string SMTP_USER { get; set; }
-	public string SMTP_PASSWORD { get; set; }
-	public string EMAIL_FROM_ADDRESS { get; set; }
-	public string EMAIL_FROM_DISPLAY_NAME { get; set; }
-	public string PORTAL_URL { get; set; }
-	public string GITHUB_CLIENT_ID { get; set; }
-	public string GITHUB_CLIENT_SECRET { get; set; }
-	public string APP_AES_KEY { get; set; }
-	/// <summary>
+    /// <summary>
+    /// An reachable ip address or url that points to a postgres database.
+    /// </summary>
+    public string DB_HOST { get; set; }
+
+    /// <summary>
+    /// The port number to use with DB_HOST to point to the postgres database.
+    /// </summary>
+    public string DB_PORT { get; set; }
+
+    /// <summary>
+    /// The database user to authenticate against postgres with.
+    /// </summary>
+    public string DB_USER { get; set; }
+
+    /// <summary>
+    /// The password for the database user to authenticate against postgres with.
+    /// </summary>
+    public string DB_PASSWORD { get; set; }
+
+    /// <summary>
+    /// The name of the main app database.
+    /// </summary>
+    public string DB_NAME { get; set; }
+
+    /// <summary>
+    /// An reachable ip address or url that points to a postgres(quartz) database.
+    /// </summary>
+    public string QUARTZ_DB_HOST { get; set; }
+
+    /// <summary>
+    /// The port number to use with QUARTZ_DB_HOST to point to the postgres(quartz) database.
+    /// </summary>
+    public string QUARTZ_DB_PORT { get; set; }
+
+    /// <summary>
+    /// The database user to authenticate against postgres(quartz) with.
+    /// </summary>
+    public string QUARTZ_DB_USER { get; set; }
+
+    /// <summary>
+    /// The password for the database user to authenticate against postgres(quartz) with.
+    /// </summary>
+    public string QUARTZ_DB_PASSWORD { get; set; }
+
+    /// <summary>
+    /// The name of the quartz database.
+    /// </summary>
+    public string QUARTZ_DB_NAME { get; set; }
+
+    public string SEQ_API_KEY { get; set; }
+    public string SEQ_API_URL { get; set; }
+    public string SMTP_HOST { get; set; }
+    public string SMTP_PORT { get; set; }
+    public string SMTP_USER { get; set; }
+    public string SMTP_PASSWORD { get; set; }
+    public string EMAIL_FROM_ADDRESS { get; set; }
+    public string EMAIL_FROM_DISPLAY_NAME { get; set; }
+    public string PORTAL_URL { get; set; }
+    public string GITHUB_CLIENT_ID { get; set; }
+    public string GITHUB_CLIENT_SECRET { get; set; }
+    public string APP_AES_KEY { get; set; }
+
+    /// <summary>
     /// A base64 string containing a passwordless pfx cert
     /// </summary>
-	public string APP_CERT { get; set; }
+    public string APP_CERT { get; set; }
 
-	public X509Certificate2 CERT1() => new (Convert.FromBase64String(APP_CERT));
+    public X509Certificate2 CERT1() => new(Convert.FromBase64String(APP_CERT));
 
-	public object GetPublicVersion() {
-		return new {
-				DB_HOST,
-				DB_PORT,
-				DB_USER,
-				DB_PASSWORD = DB_PASSWORD.Obfuscate() ?? "",
-				QUARTZ_DB_HOST,
-				QUARTZ_DB_PORT,
-				QUARTZ_DB_USER,
-				QUARTZ_DB_PASSWORD = QUARTZ_DB_PASSWORD.Obfuscate() ?? "",
-				SEQ_API_KEY = SEQ_API_KEY.Obfuscate() ?? "",
-				SEQ_API_URL,
-				SMTP_HOST,
-				SMTP_PORT,
-				SMTP_USER = SMTP_USER.Obfuscate() ?? "",
-				SMTP_PASSWORD = SMTP_PASSWORD.Obfuscate() ?? "",
-				EMAIL_FROM_ADDRESS,
-				EMAIL_FROM_DISPLAY_NAME,
-				PORTAL_URL,
-				GITHUB_CLIENT_ID = GITHUB_CLIENT_ID.Obfuscate() ?? "",
-				GITHUB_CLIENT_SECRET = GITHUB_CLIENT_SECRET.Obfuscate() ?? "",
-				APP_AES_KEY = APP_AES_KEY.Obfuscate() ?? "",
-				CERT1 = CERT1().PublicKey.Oid.FriendlyName
-		};
-	}
-}
+    public object GetPublicVersion() {
+        return new {
+            DB_HOST,
+            DB_PORT,
+            DB_USER,
+            DB_PASSWORD = DB_PASSWORD.Obfuscate() ?? "",
+            QUARTZ_DB_HOST,
+            QUARTZ_DB_PORT,
+            QUARTZ_DB_USER,
+            QUARTZ_DB_PASSWORD = QUARTZ_DB_PASSWORD.Obfuscate() ?? "",
+            SEQ_API_KEY = SEQ_API_KEY.Obfuscate() ?? "",
+            SEQ_API_URL,
+            SMTP_HOST,
+            SMTP_PORT,
+            SMTP_USER = SMTP_USER.Obfuscate() ?? "",
+            SMTP_PASSWORD = SMTP_PASSWORD.Obfuscate() ?? "",
+            EMAIL_FROM_ADDRESS,
+            EMAIL_FROM_DISPLAY_NAME,
+            PORTAL_URL,
+            GITHUB_CLIENT_ID = GITHUB_CLIENT_ID.Obfuscate() ?? "",
+            GITHUB_CLIENT_SECRET = GITHUB_CLIENT_SECRET.Obfuscate() ?? "",
+            APP_AES_KEY = APP_AES_KEY.Obfuscate() ?? "",
+            CERT1 = CERT1().PublicKey.Oid.FriendlyName
+        };
+    }
+}
\ No newline at end of file