From 26616b4cabe5d22bb3fc8e45a6d954c727facddf Mon Sep 17 00:00:00 2001
From: Developer 02 <developer02@didaloghe.onmicrosoft.com>
Date: Fri, 11 Apr 2025 15:08:37 +0200
Subject: [PATCH] Update HistoryController comments and response codes

Replaced "Verlaufshistorie" with "Umschlaghistorie" in
the `HistoryController` class to clarify API context.
Added detailed response codes for `GetReferenceTypes`
and `GetAllAsync` methods to enhance API documentation.
---
 .../Controllers/HistoryController.cs          | 25 +++++++++++++------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs b/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
index ae683738..d6eee03e 100644
--- a/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
+++ b/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
@@ -8,7 +8,7 @@ using static EnvelopeGenerator.Common.Constants;
 namespace EnvelopeGenerator.GeneratorAPI.Controllers;
 
 /// <summary>
-/// Dieser Controller bietet Endpunkte für den Zugriff auf die Verlaufshistorie von Umschlägen.
+/// Dieser Controller stellt Endpunkte für den Zugriff auf die Umschlaghistorie bereit.
 /// </summary>
 [Route("api/[controller]")]
 [ApiController]
@@ -23,7 +23,7 @@ public class HistoryController : ControllerBase
     /// Konstruktor für den HistoryController.
     /// </summary>
     /// <param name="logger">Der Logger, der für das Protokollieren von Informationen verwendet wird.</param>
-    /// <param name="service">Der Dienst, der für die Verarbeitung der Verlaufshistorie verantwortlich ist.</param>
+    /// <param name="service">Der Dienst, der für die Verarbeitung der Umschlaghistorie verantwortlich ist.</param>
     public HistoryController(ILogger<HistoryController> logger, IEnvelopeHistoryService service)
     {
         _logger = logger;
@@ -34,11 +34,16 @@ public class HistoryController : ControllerBase
     /// Ruft die verfügbaren Referenztypen ab und gibt sie als Schlüssel-Wert-Paare zurück.
     /// </summary>
     /// <returns>Ein Ok-Ergebnis mit einem Wörterbuch, das die Referenztypen als Schlüssel-Wert-Paare enthält.</returns>
+    /// <response code="200">Die Anfrage war erfolgreich, und die Referenztypen werden zurückgegeben.</response>
+    /// <response code="400">Die Anfrage war ungültig oder unvollständig.</response>
+    /// <response code="401">Der Benutzer ist nicht authentifiziert.</response>
+    /// <response code="403">Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen.</response>
+    /// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
     [HttpGet("reference-type")]
     [Authorize]
     public IActionResult GetReferenceTypes()
     {
-        // Enum to Key-Value pair
+        // Enum zu Schlüssel-Wert-Paar
         var referenceTypes = Enum.GetValues(typeof(ReferenceType))
                                  .Cast<ReferenceType>()
                                  .ToDictionary(rt =>
@@ -52,10 +57,15 @@ public class HistoryController : ControllerBase
     }
 
     /// <summary>
-    /// Ruft die gesamte Verlaufshistorie von Umschlägen basierend auf den angegebenen Abfrageparametern ab.
+    /// Ruft die gesamte Umschlaghistorie basierend auf den angegebenen Abfrageparametern ab.
     /// </summary>
-    /// <param name="history">Die Abfrageparameter, die die Filterkriterien für die Verlaufshistorie definieren.</param>
-    /// <returns>Eine Liste von Verlaufseinträgen, die den angegebenen Kriterien entsprechen.</returns>
+    /// <param name="history">Die Abfrageparameter, die die Filterkriterien für die Umschlaghistorie definieren.</param>
+    /// <returns>Eine Liste von Historieneinträgen, die den angegebenen Kriterien entsprechen.</returns>
+    /// <response code="200">Die Anfrage war erfolgreich, und die Umschlaghistorie wird zurückgegeben.</response>
+    /// <response code="400">Die Anfrage war ungültig oder unvollständig.</response>
+    /// <response code="401">Der Benutzer ist nicht authentifiziert.</response>
+    /// <response code="403">Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen.</response>
+    /// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
     [HttpGet]
     [Authorize]
     public async Task<IActionResult> GetAllAsync([FromQuery] ReadEnvelopeHistoryQuery history)
@@ -76,11 +86,10 @@ public class HistoryController : ControllerBase
 
         var histories = await _service.ReadAsync(
             envelopeId: history.EnvelopeId,
-            //userReference: history.r,
             referenceType: refTypEnum,
             withSender: withSender,
             withReceiver: withReceiver);
 
         return Ok(histories);
     }
-}
\ No newline at end of file
+}