docs: add add XML documentation

Author: kaaatz-e

AirCompany/AirCompany.Api.Host/Controllers/AircraftFamilyController.cs

@@ -5,7 +5,10 @@
 
 namespace AirCompany.Api.Host.Controllers;
 
-
+/// <summary>
+/// API Controller for managing Aircraft family entities
+/// Inherits standard CRUD
+/// </summary>
 [Route("api/[controller]")]
 [ApiController]
 public class AircraftFamilyController(IApplicationService<AircraftFamilyDto, AircraftFamilyCreateUpdateDto, Guid> service, ILogger<AircraftFamilyController> logger)

AirCompany/AirCompany.Api.Host/Controllers/AircraftModelController.cs

@@ -4,11 +4,20 @@
 
 namespace AirCompany.Api.Host.Controllers;
 
+/// <summary>
+/// The controller for controlling Aircraft models
+/// Inherits from the basic CRUD controller and adds methods for obtaining related aircraft and flight families
+/// </summary>
 [Route("api/[controller]")]
 [ApiController]
 public class AircraftModelController(IAircraftModelService service, ILogger<AircraftModelController> logger)
     : CrudControllerBase<AircraftModelDto, AircraftModelCreateUpdateDto, Guid>(service, logger)
 {
+    /// <summary>
+    /// Getting the aircraft family associated with this model
+    /// </summary>
+    /// <param name="id">Model ID</param>
+    /// <returns>DTO family</returns>
     [HttpGet("{id}/AircraftFamily")]
     [ProducesResponseType(200)]
     [ProducesResponseType(404)]

AirCompany/AirCompany.Api.Host/Controllers/AnalyticsController.cs

@@ -5,10 +5,18 @@
 
 namespace AirCompany.Api.Host.Controllers;
 
+/// <summary>
+/// The controller for airline analytics
+/// Provides aggregated data on flights and passengers
+/// </summary>
 [Route("api/[controller]")]
 [ApiController]
 public class AnalyticsController(IAnalyticsService service, ILogger<AnalyticsController> logger) : Controller
 {
+    /// <summary>
+    /// Getting the top 5 flights by number of passengers
+    /// </summary>
+    /// <returns>List of DTO flights</returns>
     [HttpGet("top-flights-by-passenger")]
     [ProducesResponseType(200)]
     [ProducesResponseType(500)]
@@ -28,6 +36,10 @@ public async Task<ActionResult<List<FlightDto>>> GetTop5FlightsByPassengerCount(
         }
     }
 
+    /// <summary>
+    /// Getting flights with a minimum duration
+    /// </summary>
+    /// <returns>List of DTO flights</returns>
     [HttpGet("flights-with-minimum-duration")]
     [ProducesResponseType(200)]
     [ProducesResponseType(500)]
@@ -47,6 +59,11 @@ public async Task<ActionResult<List<FlightDto>>> GetFlightsWithMinimumDuration()
         }
     }
 
+    /// <summary>
+    /// Receiving passengers on the selected flight without luggage
+    /// </summary>
+    /// <param name="flightId">Flight ID</param>
+    /// <returns>List of DTO passengers</returns>
     [HttpGet("passengers-with-zero-baggage-by-flight")]
     [ProducesResponseType(200)]
     [ProducesResponseType(500)]
@@ -66,6 +83,13 @@ public async Task<ActionResult<List<PassengerDto>>> GetPassengersWithZeroBaggage
         }
     }
 
+    /// <summary>
+    /// Getting flights of a certain aircraft model in a given period
+    /// </summary>
+    /// <param name="modelId">Model ID</param>
+    /// <param name="startPeriod">Beginning of the period</param>
+    /// <param name="endPeriod">End of the period</param>
+    /// <returns>List of DTO flights</returns>
     [HttpGet("flights-by-model-and-period")]
     [ProducesResponseType(200)]
     [ProducesResponseType(500)]
@@ -85,6 +109,12 @@ public async Task<ActionResult<List<PassengerDto>>> GetFlightsByModelAndPeriod(G
         }
     }
 
+    /// <summary>
+    /// Receiving flights between two airports
+    /// </summary>
+    /// <param name="departureAirport">Departure airport</param>
+    /// <param name="arrivalAirport">Airport of arrival</param>
+    /// <returns>List of DTO flights</returns>
     [HttpGet("flights-by-route")]
     [ProducesResponseType(200)]
     [ProducesResponseType(500)]

AirCompany/AirCompany.Api.Host/Controllers/CrudControllerBase.cs

@@ -3,6 +3,15 @@
 
 namespace AirCompany.Api.Host.Controllers;
 
+/// <summary>
+/// The basic controller for working with entities through CRUD operations
+/// Provides standard methods for creating, receiving, updating, and deleting data
+/// </summary>
+/// <typeparam name="TDto">DTO type for read operations</typeparam>
+/// <typeparam name="TCreateUpdateDto">DTO type for creation and update operations</typeparam>
+/// <typeparam name="TKey">The type of the DTO identifier </typeparam>
+/// <param name="appService">An application service that implements CRUD operations on DTO</param>
+/// <param name="logger">Logger for recording information about method execution and exceptions</param>
 [Route("api/[controller]")]
 [ApiController]
 public abstract class CrudControllerBase<TDto, TCreateUpdateDto, TKey>(IApplicationService<TDto, TCreateUpdateDto, TKey> appService,
@@ -11,6 +20,11 @@ public abstract class CrudControllerBase<TDto, TCreateUpdateDto, TKey>(IApplicat
     where TCreateUpdateDto : class
     where TKey : struct
 {
+    /// <summary>
+    /// Creating a new entity record
+    /// </summary>
+    /// <param name="newDto">DTO with data for creating a new entity</param>
+    /// <returns>The created DTO object with the assigned ID</returns>
     [HttpPost]
     [ProducesResponseType(201)]
     [ProducesResponseType(500)]
@@ -30,6 +44,12 @@ public async Task<ActionResult<TDto>> Create(TCreateUpdateDto newDto)
         }
     }
 
+    /// <summary>
+    /// Updating an existing entity record by ID
+    /// </summary>
+    /// <param name="id">ID of the entity to update</param>
+    /// <param name="newDto">DTO with updated data</param>
+    /// <returns>Updated DTO object</returns>
     [HttpPut("{id}")]
     [ProducesResponseType(200)]
     [ProducesResponseType(404)]
@@ -54,6 +74,11 @@ public async Task<ActionResult<TDto>> Edit(Guid id, TCreateUpdateDto newDto)
         }
     }
 
+    /// <summary>
+    /// Deleting an existing entity record by ID
+    /// </summary>
+    /// <param name="id">ID of the entity to delete</param>
+    /// <returns>true if deletion is successful, otherwise false</returns>
     [HttpDelete("{id}")]
     [ProducesResponseType(200)]
     [ProducesResponseType(204)]
@@ -74,6 +99,10 @@ public async Task<IActionResult> Delete(Guid id)
         }
     }
 
+    /// <summary>
+    /// Getting a list of all entities
+    /// </summary>
+    /// <returns>List of DTOs of all entities</returns>
     [HttpGet]
     [ProducesResponseType(200)]
     [ProducesResponseType(500)]
@@ -93,6 +122,11 @@ public async Task<ActionResult<IList<TDto>>> GetAll()
         }
     }
 
+    /// <summary>
+    /// Getting one entity by ID
+    /// </summary>
+    /// <param name="id">ID of the desired entity</param>
+    /// <returns>The DTO of the entity, if found, otherwise NotFound</returns>
     [HttpGet("{id}")]
     [ProducesResponseType(200)]
     [ProducesResponseType(404)]

AirCompany/AirCompany.Api.Host/Controllers/FlightController.cs

@@ -4,11 +4,20 @@
 
 namespace AirCompany.Api.Host.Controllers;
 
+/// <summary>
+/// The flight management controller
+/// Inherits from the basic CRUD controller and adds methods to retrieve related passengers and aircraft models
+/// </summary>
 [Route("api/[controller]")]
 [ApiController]
 public class FlightController(IFlightService service, ILogger<FlightController> logger)
     : CrudControllerBase<FlightDto, FlightCreateUpdateDto, Guid>(service, logger)
 {
+    /// <summary>
+    /// Getting the aircraft model associated with this flight
+    /// </summary>
+    /// <param name="id">Flight ID</param>
+    /// <returns>DTO of the model</returns>
     [HttpGet("{id}/AircraftModel")]
     [ProducesResponseType(200)]
     [ProducesResponseType(404)]

AirCompany/AirCompany.Api.Host/Controllers/PassengerController.cs

@@ -5,6 +5,10 @@
 
 namespace AirCompany.Api.Host.Controllers;
 
+/// <summary>
+/// API Controller for managing Passenger entities
+/// Inherits standard CRUD
+/// </summary>
 [Route("api/[controller]")]
 [ApiController]
 public class PassengerController(IApplicationService<PassengerDto, PassengerCreateUpdateDto, Guid> service, ILogger<PassengerController> logger)

AirCompany/AirCompany.Api.Host/Controllers/TicketController.cs

@@ -5,11 +5,20 @@
 
 namespace AirCompany.Api.Host.Controllers;
 
+/// <summary>
+/// The ticket management controller
+/// Inherits from the basic CRUD controller and adds methods to retrieve the associated passenger and flight
+/// </summary>
 [Route("api/[controller]")]
 [ApiController]
 public class TicketController(ITicketService service, ILogger<TicketController> logger)
     : CrudControllerBase<TicketDto, TicketCreateUpdateDto, Guid>(service, logger)
 {
+    /// <summary>
+    /// Receipt of the flight to which this ticket is attached
+    /// </summary>
+    /// <param name="id">Ticket ID</param>
+    /// <returns>Flight DTO</returns>
     [HttpGet("{id}/Flight")]
     [ProducesResponseType(200)]
     [ProducesResponseType(404)]
@@ -35,6 +44,11 @@ public async Task<ActionResult<FlightDto>> GetFlight(Guid id)
         }
     }
 
+    /// <summary>
+    /// Receipt of the passenger who owns this ticket
+    /// </summary>
+    /// <param name="id">Ticket ID</param>
+    /// <returns>Passenger's DTO</returns>
     [HttpGet("{id}/Passenger")]
     [ProducesResponseType(200)]
     [ProducesResponseType(404)]

AirCompany/AirCompany.Application.Contracts/AircraftFamily/AircraftFamilyCreateUpdateDto.cs

@@ -1,3 +1,8 @@
 namespace AirCompany.Application.Contracts.AircraftFamily;
 
+/// <summary>
+/// DTO for creating and updating aircraft family information
+/// </summary>
+/// <param name="FamilyName">The name of the aircraft family</param>
+/// <param name="Manufacturer">The manufacturer of the aircraft family</param>
 public record AircraftFamilyCreateUpdateDto(string FamilyName, string Manufacturer);

AirCompany/AirCompany.Application.Contracts/AircraftFamily/AircraftFamilyDto.cs

@@ -1,3 +1,10 @@
 namespace AirCompany.Application.Contracts.AircraftFamily;
 
+
+/// <summary>
+/// DTO for reading aircraft family information
+/// </summary>
+/// <param name="Id">The unique identifier of the aircraft family</param>
+/// <param name="FamilyName">The name of the aircraft family</param>
+/// <param name="Manufacturer">The manufacturer of the aircraft family</param>
 public record AircraftFamilyDto(Guid Id, string FamilyName, string Manufacturer);

AirCompany/AirCompany.Application.Contracts/AircraftModel/AircraftModelCreateUpdateDto.cs

@@ -1,2 +1,11 @@
 namespace AirCompany.Application.Contracts.AircraftModel;
+
+/// <summary>
+/// Data transfer object for creating and updating aircraft model information
+/// </summary>
+/// <param name="ModelName">The name of the aircraft model</param>
+/// <param name="FlightRangeKm">The maximum flight range in kilometers that this aircraft model can achieve</param>
+/// <param name="PassengerCapacity">The maximum number of passengers this aircraft model can accommodate</param>
+/// <param name="CargoCapacityKg">The maximum cargo capacity in kilograms this aircraft model can carry</param>
+/// <param name="AircraftFamily">The unique identifier of the aircraft family to which this model belongs</param>
 public record AircraftModelCreateUpdateDto(string ModelName, double FlightRangeKm, int PassengerCapacity, double CargoCapacityKg, Guid AircraftFamily);