From 123ff5c4f9d587c0660fdc1437ca7800b03c1ee8 Mon Sep 17 00:00:00 2001
From: Blake Niemyjski <bniemyjski@gmail.com>
Date: Thu, 19 Dec 2024 21:25:55 -0600
Subject: [PATCH] Improved api documentation

---
 src/Exceptionless.Core/Configuration/EmailOptions.cs |  2 +-
 src/Exceptionless.Web/Controllers/EventController.cs |  4 ++--
 .../Controllers/OrganizationController.cs            |  2 +-
 .../Controllers/ProjectController.cs                 |  2 +-
 src/Exceptionless.Web/Controllers/StackController.cs | 12 ++++++------
 .../Controllers/WebHookController.cs                 |  2 +-
 6 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/Exceptionless.Core/Configuration/EmailOptions.cs b/src/Exceptionless.Core/Configuration/EmailOptions.cs
index 5c8b07aa65..17d560d967 100644
--- a/src/Exceptionless.Core/Configuration/EmailOptions.cs
+++ b/src/Exceptionless.Core/Configuration/EmailOptions.cs
@@ -16,7 +16,7 @@ public class EmailOptions
     public string? TestEmailAddress { get; internal set; }
 
     /// <summary>
-    /// Email addresses that match this comma delimited list of domains and email addresses will be allowed to be sent out in QA mode
+    /// Email addresses that match this comma-delimited list of domains and email addresses will be allowed to be sent out in QA mode
     /// </summary>
     public List<string> AllowedOutboundAddresses { get; internal set; } = null!;
 
diff --git a/src/Exceptionless.Web/Controllers/EventController.cs b/src/Exceptionless.Web/Controllers/EventController.cs
index ca35362fb8..6822a84ebb 100644
--- a/src/Exceptionless.Web/Controllers/EventController.cs
+++ b/src/Exceptionless.Web/Controllers/EventController.cs
@@ -137,7 +137,7 @@ public async Task<ActionResult<CountResult>> GetCountByOrganizationAsync(string
     /// <param name="aggregations">A list of values you want returned. Example: avg:value cardinality:value sum:users max:value min:value</param>
     /// <param name="time">The time filter that limits the data being returned to a specific date range.</param>
     /// <param name="offset">The time offset in minutes that controls what data is returned based on the time filter. This is used for time zone support.</param>
-    /// <param name="mode">If no mode is set then the whole event object will be returned. If the mode is set to summary than a lightweight object will be returned.</param>
+    /// <param name="mode">If mode is set to stack_new, then additional filters will be added.</param>
     /// <response code="400">Invalid filter.</response>
     [HttpGet("~/" + API_PREFIX + "/projects/{projectId:objectid}/events/count")]
     [Authorize(Policy = AuthorizationRoles.UserPolicy)]
@@ -1341,7 +1341,7 @@ await _eventPostService.EnqueueAsync(new EventPost(_appOptions.EnableArchive)
     /// <summary>
     /// Remove
     /// </summary>
-    /// <param name="ids">A comma delimited list of event identifiers.</param>
+    /// <param name="ids">A comma-delimited list of event identifiers.</param>
     /// <response code="204">No Content.</response>
     /// <response code="400">One or more validation errors occurred.</response>
     /// <response code="404">One or more event occurrences were not found.</response>
diff --git a/src/Exceptionless.Web/Controllers/OrganizationController.cs b/src/Exceptionless.Web/Controllers/OrganizationController.cs
index 58f73ee7c5..48200f28a3 100644
--- a/src/Exceptionless.Web/Controllers/OrganizationController.cs
+++ b/src/Exceptionless.Web/Controllers/OrganizationController.cs
@@ -169,7 +169,7 @@ public Task<ActionResult<ViewOrganization>> PatchAsync(string id, Delta<NewOrgan
     /// <summary>
     /// Remove
     /// </summary>
-    /// <param name="ids">A comma delimited list of organization identifiers.</param>
+    /// <param name="ids">A comma-delimited list of organization identifiers.</param>
     /// <response code="204">No Content.</response>
     /// <response code="400">One or more validation errors occurred.</response>
     /// <response code="404">One or more organizations were not found.</response>
diff --git a/src/Exceptionless.Web/Controllers/ProjectController.cs b/src/Exceptionless.Web/Controllers/ProjectController.cs
index 6b30ec1421..d3b0625a70 100644
--- a/src/Exceptionless.Web/Controllers/ProjectController.cs
+++ b/src/Exceptionless.Web/Controllers/ProjectController.cs
@@ -183,7 +183,7 @@ public Task<ActionResult<ViewProject>> PatchAsync(string id, Delta<UpdateProject
     /// <summary>
     /// Remove
     /// </summary>
-    /// <param name="ids">A comma delimited list of project identifiers.</param>
+    /// <param name="ids">A comma-delimited list of project identifiers.</param>
     /// <response code="204">No Content.</response>
     /// <response code="400">One or more validation errors occurred.</response>
     /// <response code="404">One or more projects were not found.</response>
diff --git a/src/Exceptionless.Web/Controllers/StackController.cs b/src/Exceptionless.Web/Controllers/StackController.cs
index 1ee446b33b..567f76579f 100644
--- a/src/Exceptionless.Web/Controllers/StackController.cs
+++ b/src/Exceptionless.Web/Controllers/StackController.cs
@@ -99,7 +99,7 @@ public async Task<ActionResult<Stack>> GetAsync(string id, string? offset = null
     /// <summary>
     /// Mark fixed
     /// </summary>
-    /// <param name="ids">A comma delimited list of stack identifiers.</param>
+    /// <param name="ids">A comma-delimited list of stack identifiers.</param>
     /// <param name="version">A version number that the stack was fixed in.</param>
     /// <response code="404">One or more stacks could not be found.</response>
     [HttpPost("{ids:objectids}/mark-fixed")]
@@ -160,7 +160,7 @@ public async Task<ActionResult> MarkFixedAsync(JObject data)
     /// <summary>
     /// Mark the selected stacks as snoozed
     /// </summary>
-    /// <param name="ids">A comma delimited list of stack identifiers.</param>
+    /// <param name="ids">A comma-delimited list of stack identifiers.</param>
     /// <param name="snoozeUntilUtc">A time that the stack should be snoozed until.</param>
     /// <response code="404">One or more stacks could not be found.</response>
     [HttpPost("{ids:objectids}/mark-snoozed")]
@@ -279,7 +279,7 @@ public async Task<IActionResult> RemoveLinkAsync(string id, ValueFromBody<string
     /// <summary>
     /// Mark future occurrences as critical
     /// </summary>
-    /// <param name="ids">A comma delimited list of stack identifiers.</param>
+    /// <param name="ids">A comma-delimited list of stack identifiers.</param>
     /// <response code="404">One or more stacks could not be found.</response>
     [HttpPost("{ids:objectids}/mark-critical")]
     [Authorize(Policy = AuthorizationRoles.UserPolicy)]
@@ -304,7 +304,7 @@ public async Task<IActionResult> MarkCriticalAsync(string ids)
     /// <summary>
     /// Mark future occurrences as not critical
     /// </summary>
-    /// <param name="ids">A comma delimited list of stack identifiers.</param>
+    /// <param name="ids">A comma-delimited list of stack identifiers.</param>
     /// <response code="204">The stacks were marked as not critical.</response>
     /// <response code="404">One or more stacks could not be found.</response>
     [HttpDelete("{ids:objectids}/mark-critical")]
@@ -331,7 +331,7 @@ public async Task<IActionResult> MarkNotCriticalAsync(string ids)
     /// <summary>
     /// Change stack status
     /// </summary>
-    /// <param name="ids">A comma delimited list of stack identifiers.</param>
+    /// <param name="ids">A comma-delimited list of stack identifiers.</param>
     /// <param name="status">The status that the stack should be changed to.</param>
     /// <response code="404">One or more stacks could not be found.</response>
     [HttpPost("{ids:objectids}/change-status")]
@@ -444,7 +444,7 @@ await _webHookNotificationQueue.EnqueueAsync(new WebHookNotification
     /// <summary>
     /// Remove
     /// </summary>
-    /// <param name="ids">A comma delimited list of stack identifiers.</param>
+    /// <param name="ids">A comma-delimited list of stack identifiers.</param>
     /// <response code="204">No Content.</response>
     /// <response code="400">One or more validation errors occurred.</response>
     /// <response code="404">One or more stacks were not found.</response>
diff --git a/src/Exceptionless.Web/Controllers/WebHookController.cs b/src/Exceptionless.Web/Controllers/WebHookController.cs
index 1ffa7c3e98..db8249a07a 100644
--- a/src/Exceptionless.Web/Controllers/WebHookController.cs
+++ b/src/Exceptionless.Web/Controllers/WebHookController.cs
@@ -82,7 +82,7 @@ public Task<ActionResult<WebHook>> PostAsync(NewWebHook webhook)
     /// <summary>
     /// Remove
     /// </summary>
-    /// <param name="ids">A comma delimited list of web hook identifiers.</param>
+    /// <param name="ids">A comma-delimited list of web hook identifiers.</param>
     /// <response code="204">No Content.</response>
     /// <response code="400">One or more validation errors occurred.</response>
     /// <response code="404">One or more web hooks were not found.</response>