diff --git a/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs b/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs index ce9147a2..fac5d1d3 100644 --- a/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs +++ b/EnvelopeGenerator.GeneratorAPI/Controllers/EnvelopeController.cs @@ -11,6 +11,14 @@ namespace EnvelopeGenerator.GeneratorAPI.Controllers; /// /// /// Die API ermöglicht das Abrufen und Verwalten von Umschlägen basierend auf Benutzerinformationen und Statusfiltern. +/// +/// Mögliche Antworten: +/// - 200 OK: Die Anfrage war erfolgreich, und die angeforderten Daten werden zurückgegeben. +/// - 400 Bad Request: Die Anfrage war fehlerhaft oder unvollständig. +/// - 401 Unauthorized: Der Benutzer ist nicht authentifiziert. +/// - 403 Forbidden: Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen. +/// - 404 Not Found: Die angeforderte Ressource wurde nicht gefunden. +/// - 500 Internal Server Error: Ein unerwarteter Fehler ist aufgetreten. /// [Route("api/[controller]")] [ApiController] @@ -36,6 +44,11 @@ public class EnvelopeController : ControllerBase /// /// Die Statusfilter, die für die Abfrage verwendet werden sollen. /// Eine IActionResult-Instanz, die die abgerufenen Umschläge oder einen Fehlerstatus enthält. + /// Die Anfrage war erfolgreich, und die Umschläge werden zurückgegeben. + /// Die Anfrage war fehlerhaft oder unvollständig. + /// Der Benutzer ist nicht authentifiziert. + /// Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen. + /// Ein unerwarteter Fehler ist aufgetreten. [Authorize] [HttpGet] public async Task GetAsync(