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

Add XML documentation for GetReferenceTypes method

Browse Source 
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.
This commit is contained in:
Developer 02 2025-04-10 18:57:48 +02:00
parent 99b0dba79f
commit 6550be0235
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs
View File

@ -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<int>()).ThenAsync(
Success: Ok,
Fail: IActionResult (msg, ntc) =>
{

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

@ -30,6 +30,10 @@ public class HistoryController : ControllerBase
_service = service;
}
/// <summary>
/// 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>
[HttpGet("reference-type")]
[Authorize]
public IActionResult GetReferenceTypes()