From 6550be02356c0481616c31656cbfea0bf39d17e5 Mon Sep 17 00:00:00 2001 From: Developer 02 Date: Thu, 10 Apr 2025 18:57:48 +0200 Subject: [PATCH] Add XML documentation for GetReferenceTypes method This commit introduces XML documentation comments to the GetReferenceTypes method in the HistoryController class. The comments clarify the method's purpose, indicating that it retrieves available reference types and returns them as key-value pairs, along with a summary and return type information. --- .../Controllers/EnvelopeController.cs | 2 +- .../Controllers/HistoryController.cs | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs b/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs index 5cf96857..ce9147a2 100644 --- a/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs +++ b/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs @@ -44,7 +44,7 @@ public class EnvelopeController : ControllerBase try { if (User.GetId() is int intId) - return await _envelopeService.ReadByUserAsync(intId, min_status: status.Min, max_status: status.Max, ignore_statuses: status.Ignore).ThenAsync( + return await _envelopeService.ReadByUserAsync(intId, min_status: status.Min, max_status: status.Max, ignore_statuses: status.Ignore ?? Array.Empty()).ThenAsync( Success: Ok, Fail: IActionResult (msg, ntc) => { diff --git a/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs b/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs index 89dcf8ce..ae683738 100644 --- a/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs +++ b/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs @@ -30,6 +30,10 @@ public class HistoryController : ControllerBase _service = service; } + /// + /// Ruft die verfügbaren Referenztypen ab und gibt sie als Schlüssel-Wert-Paare zurück. + /// + /// Ein Ok-Ergebnis mit einem Wörterbuch, das die Referenztypen als Schlüssel-Wert-Paare enthält. [HttpGet("reference-type")] [Authorize] public IActionResult GetReferenceTypes()