docs: add xml doc for request

This commit is contained in:
Polianin Nikita 2024-05-29 03:41:54 +03:00
parent ba8ccf8b7e
commit 2d67a565ca

View File

@ -2,21 +2,43 @@
namespace Mirea.Api.Dto.Requests.Configuration; namespace Mirea.Api.Dto.Requests.Configuration;
/// <summary>
/// Represents a request to configure the database connection settings.
/// </summary>
public class DatabaseRequest public class DatabaseRequest
{ {
/// <summary>
/// Gets or sets the server address.
/// </summary>
[Required] [Required]
public required string Server { get; set; } public required string Server { get; set; }
/// <summary>
/// Gets or sets the port number.
/// </summary>
[Required] [Required]
public int Port { get; set; } public int Port { get; set; }
/// <summary>
/// Gets or sets the database name.
/// </summary>
[Required] [Required]
public required string Database { get; set; } public required string Database { get; set; }
/// <summary>
/// Gets or sets the username.
/// </summary>
[Required] [Required]
public required string User { get; set; } public required string User { get; set; }
/// <summary>
/// Gets or sets a value indicating whether SSL is enabled.
/// </summary>
[Required] [Required]
public bool Ssl { get; set; } public bool Ssl { get; set; }
/// <summary>
/// Gets or sets the password.
/// </summary>
public string? Password { get; set; } public string? Password { get; set; }
} }