Adjust documentation in user controller

This commit is contained in:
2025-08-03 18:15:12 -06:00
parent e456913233
commit fc8d385a13

View File

@@ -26,7 +26,7 @@ namespace LSA.Core.Thalos.API.Controllers
public class UserController(IUserProvider service) : ControllerBase
{
/// <summary>
/// mongo identifier all the users.
/// Gets all users.
/// </summary>
/// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
/// <returns>The <see cref="IEnumerable{UserAdapter}"/> found entity.</returns>
@@ -41,7 +41,7 @@ namespace LSA.Core.Thalos.API.Controllers
}
/// <summary>
/// mongo identifier the user by identifier.
/// Gets the user by mongo identifier.
/// </summary>
/// <param name="_id">The user Mongo identifier.</param>
/// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
@@ -58,7 +58,7 @@ namespace LSA.Core.Thalos.API.Controllers
}
/// <summary>
/// mongo identifier the user by email.
/// Gets the user by email.
/// </summary>
/// <param name="email">The user's email.</param>
/// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
@@ -106,7 +106,7 @@ namespace LSA.Core.Thalos.API.Controllers
}
/// <summary>
/// Updates a full user by identifier.
/// Updates a full user by mongo identifier.
/// </summary>
/// <param name="_id">The user Mongo identifier.</param>
/// <param name="entity">The user to update.</param>
@@ -175,7 +175,7 @@ namespace LSA.Core.Thalos.API.Controllers
}
/// <summary>
/// mongo identifier a token for the user, including roles, permissions, and modules.
/// Gets a token for the user, including roles, permissions, and modules.
/// </summary>
/// <param name="email">The user's email.</param>
/// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
@@ -191,7 +191,7 @@ namespace LSA.Core.Thalos.API.Controllers
}
/// <summary>
/// Deletes a user by identifier.
/// Deletes a user by mongo identifier.
/// </summary>
/// <param name="_id">The user Mongo identifier.</param>
/// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>