From afa6dda16f8ee8c117fcc55120ce5fb6c804a950 Mon Sep 17 00:00:00 2001
From: Developer 02 <developer02@didaloghe.onmicrosoft.com>
Date: Fri, 11 Apr 2025 21:08:23 +0200
Subject: [PATCH] Update documentation for GetReferenceTypes method

Significantly revised the comments for the GetReferenceTypes method in the HistoryController class. Removed previous summary and response code details, and added a detailed description of the roles involved in the envelope sending process (Receiver, Sender, System, Unknown). Improved clarity with a list format and simplified return type documentation.
---
 .../Controllers/HistoryController.cs          | 21 ++++++++++++-------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs b/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
index 63716b05..2edc4e41 100644
--- a/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
+++ b/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
@@ -31,15 +31,20 @@ public class HistoryController : ControllerBase
     }
 
     /// <summary>
-    /// Ruft die verfügbaren Referenztypen ab und gibt sie als Schlüssel-Wert-Paare zurück.
+    /// An der Versendung eines Umschlags können mehrere Beteiligte beteiligt sein, darunter der Absender, der Empfänger und das System selbst.
+    /// Der Prozess liefert alle relevanten Nenner, die mit der Schlüsselnummer verbunden sind, und ermöglicht es dem Kunden,
+    /// die Aktualität und Richtigkeit der Informationen zu überprüfen.
+    /// <list type="bullet">
+    /// <item><description><c>0</c>: Receiver</description></item>
+    /// <item><description><c>1</c>: Sender</description></item>
+    /// <item><description><c>2</c>: System</description></item>
+    /// <item><description><c>3</c>: Unknown
+    /// (Ein unbekannter Datensatz weist auf einen möglichen Mangel oder eine Unstimmigkeit im Aktualisierungsprozess der Anwendung hin.)</description></item>
+    /// </list>
     /// </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")]
+    /// <returns></returns>
+    /// <response code="200"></response>
+    [HttpGet("related")]
     [Authorize]
     public IActionResult GetReferenceTypes()
     {