refactor(api): migrate users.getUsernameSuggestion endpoint to openapi with ajv validation

.changeset/migrate-users-getUsernameSuggestion-to-AJV.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/rest-typings': minor
+'@rocket.chat/meteor': minor
+---
+
+Migrate users.getUsernameSuggestion endpoint to make it openAPI and AJV compatible

apps/meteor/app/api/server/v1/users.ts

@@ -878,6 +878,33 @@ const usersEndpoints = API.v1
 
 			return API.v1.success({ suggestions });
 		},
+	)
+	.get(
+		'users.getUsernameSuggestion',
+		{
+			authRequired: true,
+			userWithoutUsername: true,
+			response: {
+				200: ajv.compile({
+					type: 'object',
+					properties: {
+						result: { type: 'string' },
+						success: {
+							type: 'boolean',
+							enum: [true],
+						},
+					},
+					required: ['result', 'success'],
+					additionalProperties: false,
+				}),
+				401: validateUnauthorizedErrorResponse,
+			},
+		},
+		async function action() {
+			const result = await generateUsernameSuggestion(this.user);
+
+			return API.v1.success({ result });
+		},
 	);
 
 API.v1.addRoute(
@@ -921,18 +948,6 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
-	'users.getUsernameSuggestion',
-	{ authRequired: true, userWithoutUsername: true },
-	{
-		async get() {
-			const result = await generateUsernameSuggestion(this.user);
-
-			return API.v1.success({ result });
-		},
-	},
-);
-
 API.v1.addRoute(
 	'users.checkUsernameAvailability',
 	{

packages/rest-typings/src/v1/users.ts

@@ -249,12 +249,6 @@ export type UsersEndpoints = {
 		};
 	};
 
-	'/v1/users.getUsernameSuggestion': {
-		GET: () => {
-			result: string;
-		};
-	};
-
 	'/v1/users.checkUsernameAvailability': {
 		GET: (params: { username: string }) => {
 			result: boolean;