From 79a0c629b7d7d187ac04ad4069adfe8aa927cac3 Mon Sep 17 00:00:00 2001
From: ivarlovlie <git@ivarlovlie.no>
Date: Sun, 3 Jul 2022 12:27:56 +0200
Subject: refactor: Clarify which environment variables the app consumes

---
 server/src/Data/Static/AppEnvironmentVariables.cs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'server/src/Data/Static/AppEnvironmentVariables.cs')

diff --git a/server/src/Data/Static/AppEnvironmentVariables.cs b/server/src/Data/Static/AppEnvironmentVariables.cs
index 4555bfb..2a2d591 100644
--- a/server/src/Data/Static/AppEnvironmentVariables.cs
+++ b/server/src/Data/Static/AppEnvironmentVariables.cs
@@ -2,8 +2,20 @@ namespace IOL.GreatOffice.Api.Data.Static;
 
 public static class AppEnvironmentVariables
 {
+	/// <summary>
+	/// An access token that can be used to access the Hashicorp Vault instance that is available at VAULT_URL
+	/// </summary>
 	public const string VAULT_TOKEN = "VAULT_TOKEN";
+	/// <summary>
+	/// An url pointing to the Hashicorp Vault instance the app should use
+	/// </summary>
 	public const string VAULT_URL = "VAULT_URL";
+	/// <summary>
+	/// The vault key name for the main configuration json object, described by <see cref="AppConfiguration"/> 
+	/// </summary>
 	public const string MAIN_CONFIG_SHEET = "MAIN_CONFIG_SHEET";
+	/// <summary>
+	/// The duration of which to keep a local cached version of the configuration
+	/// </summary>
 	public const string VAULT_CACHE_TTL = "CONFIG_CACHE_TTL";
 }
-- 
cgit v1.3