Deduplicate invalid username error message, document UpdateUser API endpoint more

Author: Toastbrot236

Refresh.Interfaces.APIv3/Endpoints/Admin/AdminUserApiEndpoints.cs

@@ -164,8 +164,16 @@ public ApiOkResponse ResetUserPlanetsByUsername(RequestContext context, GameData
 
     [ApiV3Endpoint("admin/users/{idType}/{id}", HttpMethods.Patch), MinimumRole(GameUserRole.Moderator)]
     [DocSummary("Updates the specified user's profile with the given data")]
+    [DocError(typeof(ApiNotFoundError), ApiNotFoundError.UserMissingErrorWhen)]
+    [DocError(typeof(ApiValidationError), ApiValidationError.MayNotOverwriteRoleErrorWhen)]
+    [DocError(typeof(ApiValidationError), ApiValidationError.RoleMissingErrorWhen)]
+    [DocError(typeof(ApiValidationError), ApiValidationError.WrongRoleUpdateMethodErrorWhen)]
+    [DocError(typeof(ApiNotFoundError), ApiNotFoundError.IconMissingErrorWhen)]
+    [DocError(typeof(ApiValidationError), ApiValidationError.InvalidUsernameErrorWhen)]
     public ApiResponse<ApiExtendedGameUserResponse> UpdateUser(RequestContext context, GameDatabaseContext database,
-        GameUser user, ApiAdminUpdateUserRequest body, DataContext dataContext, string idType, string id)
+        GameUser user, ApiAdminUpdateUserRequest body, DataContext dataContext, 
+        [DocSummary("The type of identifier used to look up the user. Can be either 'uuid' or 'username'.")] string idType, 
+        [DocSummary("The UUID or username of the user, depending on the specified ID type.")] string id)
     {
         GameUser? targetUser = database.GetUserByIdAndType(idType, id);
 
@@ -190,20 +198,19 @@ public ApiResponse<ApiExtendedGameUserResponse> UpdateUser(RequestContext contex
         }
 
         if (body.IconHash != null && database.GetAssetFromHash(body.IconHash) == null)
-            return ApiNotFoundError.Instance;
+            return ApiNotFoundError.IconMissingError;
 
         if (body.VitaIconHash != null && database.GetAssetFromHash(body.VitaIconHash) == null)
-            return ApiNotFoundError.Instance;
+            return ApiNotFoundError.IconMissingError;
 
         if (body.BetaIconHash != null && database.GetAssetFromHash(body.BetaIconHash) == null)
-            return ApiNotFoundError.Instance;
+            return ApiNotFoundError.IconMissingError;
 
-        if (body.Username != null) {
+        if (body.Username != null) 
+        {
             if (!database.IsUsernameValid(body.Username))
-                return new ApiValidationError(
-                    "The username must be valid. " +
-                    "The requirements are 3 to 16 alphanumeric characters, plus hyphens and underscores. " +
-                    "Are you sure you used a PSN/RPCN username?");
+                return new ApiValidationError(ApiValidationError.InvalidUsernameErrorWhen
+                    + " Are you sure you used a PSN/RPCN username?");
 
             database.RenameUser(targetUser, body.Username);
         }

Refresh.Interfaces.APIv3/Endpoints/ApiTypes/Errors/ApiNotFoundError.cs

@@ -24,6 +24,9 @@ public class ApiNotFoundError : ApiError
 
     public const string PhotoMissingErrorWhen = "The photo could not be found";
     public static readonly ApiNotFoundError PhotoMissingError = new(PhotoMissingErrorWhen);
+
+    public const string IconMissingErrorWhen = "The icon could not be found";
+    public static readonly ApiNotFoundError IconMissingError = new(IconMissingErrorWhen);
 
     public const string ContestMissingErrorWhen = "The contest could not be found";
     public static readonly ApiNotFoundError ContestMissingError = new(ContestMissingErrorWhen);

Refresh.Interfaces.APIv3/Endpoints/ApiTypes/Errors/ApiValidationError.cs

@@ -76,6 +76,9 @@ public class ApiValidationError : ApiError
 
     public const string ContestDataMissingErrorWhen = "The contest must at least have a title, aswell as a start and end date specified";
     public static readonly ApiValidationError ContestDataMissingError = new(ContestDataMissingErrorWhen);
+
+    public const string InvalidUsernameErrorWhen = "The username must be valid. The requirements are 3 to 16 alphanumeric characters, plus hyphens and underscores.";
+    public static readonly ApiValidationError InvalidUsernameError = new(InvalidUsernameErrorWhen);
 
     public ApiValidationError(string message) : base(message) {}
 }

Refresh.Interfaces.APIv3/Endpoints/AuthenticationApiEndpoints.cs

@@ -288,6 +288,7 @@ public ApiOkResponse DenyVerificationRequest(RequestContext context, GameDatabas
 
     [ApiV3Endpoint("register", HttpMethods.Post), Authentication(false)]
     [DocSummary("Registers a new user.")]
+    [DocError(typeof(ApiValidationError), ApiValidationError.InvalidUsernameErrorWhen)]
     [DocRequestBody(typeof(ApiRegisterRequest))]
     #if !DEBUG
     [RateLimitSettings(3600, 10, 3600 / 2, "register")]
@@ -315,10 +316,8 @@ public ApiResponse<IApiAuthenticationResponse> Register(RequestContext context,
             return new ApiAuthenticationError("You aren't allowed to play on this instance.");
 
         if (!database.IsUsernameValid(body.Username))
-            return new ApiValidationError(
-                "The username must be valid. " +
-                "The requirements are 3 to 16 alphanumeric characters, plus hyphens and underscores. " +
-                "Are you sure you used your PSN/RPCN username?");
+            return new ApiValidationError(ApiValidationError.InvalidUsernameErrorWhen
+                + " Are you sure you used your PSN/RPCN username?");
 
         if (database.IsUsernameQueued(body.Username) || database.IsEmailQueued(body.EmailAddress))
             return UserInQueueError();