AppStd/EnvelopeGenerator
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update documentation for GetReferenceTypes method

Browse Source 
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.
This commit is contained in:
Developer 02 2025-04-11 21:08:23 +02:00
parent 994c844f25
commit afa6dda16f
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
View File

@ -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()
{