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;
///
-/// 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.
///
[Route("api/[controller]")]
[ApiController]
@@ -23,7 +23,7 @@ public class HistoryController : ControllerBase
/// Konstruktor für den HistoryController.
///
/// Der Logger, der für das Protokollieren von Informationen verwendet wird.
- /// Der Dienst, der für die Verarbeitung der Verlaufshistorie verantwortlich ist.
+ /// Der Dienst, der für die Verarbeitung der Umschlaghistorie verantwortlich ist.
public HistoryController(ILogger 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.
///
/// Ein Ok-Ergebnis mit einem Wörterbuch, das die Referenztypen als Schlüssel-Wert-Paare enthält.
+ /// Die Anfrage war erfolgreich, und die Referenztypen werden zurückgegeben.
+ /// Die Anfrage war ungültig oder unvollständig.
+ /// Der Benutzer ist nicht authentifiziert.
+ /// Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen.
+ /// Ein unerwarteter Fehler ist aufgetreten.
[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()
.ToDictionary(rt =>
@@ -52,10 +57,15 @@ public class HistoryController : ControllerBase
}
///
- /// Ruft die gesamte Verlaufshistorie von Umschlägen basierend auf den angegebenen Abfrageparametern ab.
+ /// Ruft die gesamte Umschlaghistorie basierend auf den angegebenen Abfrageparametern ab.
///
- /// Die Abfrageparameter, die die Filterkriterien für die Verlaufshistorie definieren.
- /// Eine Liste von Verlaufseinträgen, die den angegebenen Kriterien entsprechen.
+ /// Die Abfrageparameter, die die Filterkriterien für die Umschlaghistorie definieren.
+ /// Eine Liste von Historieneinträgen, die den angegebenen Kriterien entsprechen.
+ /// Die Anfrage war erfolgreich, und die Umschlaghistorie wird zurückgegeben.
+ /// Die Anfrage war ungültig oder unvollständig.
+ /// Der Benutzer ist nicht authentifiziert.
+ /// Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen.
+ /// Ein unerwarteter Fehler ist aufgetreten.
[HttpGet]
[Authorize]
public async Task 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
+}