chore: Add OpenAPI Support to users.getAvatarSuggestion API

.changeset/rare-waves-help.md

@@ -0,0 +1,6 @@
+---
+"@rocket.chat/meteor": minor
+"@rocket.chat/rest-typings": minor
+---
+
+Add OpenAPI support for the Rocket.Chat users.getAvatarSuggestion API endpoints by migrating to a modern chained route definition syntax and utilizing shared AJV schemas for validation to enhance API documentation and ensure type safety through response validation.

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

@@ -19,6 +19,8 @@ import {
 	isUsersCheckUsernameAvailabilityParamsGET,
 	isUsersSendConfirmationEmailParamsPOST,
 	ajv,
+	validateBadRequestErrorResponse,
+	validateUnauthorizedErrorResponse,
 } from '@rocket.chat/rest-typings';
 import { getLoginExpirationInMs, wrapExceptions } from '@rocket.chat/tools';
 import { Accounts } from 'meteor/accounts-base';
@@ -97,20 +99,6 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
-	'users.getAvatarSuggestion',
-	{
-		authRequired: true,
-	},
-	{
-		async get() {
-			const suggestions = await getAvatarSuggestionForUser(this.user);
-
-			return API.v1.success({ suggestions });
-		},
-	},
-);
-
 API.v1.addRoute(
 	'users.update',
 	{ authRequired: true, twoFactorRequired: true, validateParams: isUsersUpdateParamsPOST },
@@ -764,72 +752,132 @@ API.v1.addRoute(
 	},
 );
 
-const usersEndpoints = API.v1.post(
-	'users.createToken',
-	{
-		authRequired: true,
-		body: ajv.compile<{ userId: string; secret: string }>({
-			type: 'object',
-			properties: {
-				userId: {
-					type: 'string',
-					minLength: 1,
-				},
-				secret: {
-					type: 'string',
-					minLength: 1,
-				},
-			},
-			required: ['userId', 'secret'],
-			additionalProperties: false,
-		}),
-		response: {
-			200: ajv.compile<{ data: { userId: string; authToken: string } }>({
+const usersEndpoints = API.v1
+	.post(
+		'users.createToken',
+		{
+			authRequired: true,
+			body: ajv.compile<{ userId: string; secret: string }>({
 				type: 'object',
 				properties: {
-					data: {
-						type: 'object',
-						properties: {
-							userId: {
-								type: 'string',
-								minLength: 1,
-							},
-							authToken: {
-								type: 'string',
-								minLength: 1,
-							},
-						},
-						required: ['userId'],
-						additionalProperties: false,
+					userId: {
+						type: 'string',
+						minLength: 1,
 					},
-					success: {
-						type: 'boolean',
-						enum: [true],
+					secret: {
+						type: 'string',
+						minLength: 1,
 					},
 				},
-				required: ['data', 'success'],
-				additionalProperties: false,
-			}),
-			400: ajv.compile({
-				type: 'object',
-				properties: {
-					success: { type: 'boolean', enum: [false] },
-					error: { type: 'string' },
-					errorType: { type: 'string' },
-				},
-				required: ['success'],
+				required: ['userId', 'secret'],
 				additionalProperties: false,
 			}),
+			response: {
+				200: ajv.compile<{ data: { userId: string; authToken: string } }>({
+					type: 'object',
+					properties: {
+						data: {
+							type: 'object',
+							properties: {
+								userId: {
+									type: 'string',
+									minLength: 1,
+								},
+								authToken: {
+									type: 'string',
+									minLength: 1,
+								},
+							},
+							required: ['userId'],
+							additionalProperties: false,
+						},
+						success: {
+							type: 'boolean',
+							enum: [true],
+						},
+					},
+					required: ['data', 'success'],
+					additionalProperties: false,
+				}),
+				400: ajv.compile({
+					type: 'object',
+					properties: {
+						success: { type: 'boolean', enum: [false] },
+						error: { type: 'string' },
+						errorType: { type: 'string' },
+					},
+					required: ['success'],
+					additionalProperties: false,
+				}),
+			},
 		},
-	},
-	async function action() {
-		const user = await getUserFromParams(this.bodyParams);
+		async function action() {
+			const user = await getUserFromParams(this.bodyParams);
 
-		const data = await generateAccessToken(user._id, this.bodyParams.secret);
+			const data = await generateAccessToken(user._id, this.bodyParams.secret);
 
-		return API.v1.success({ data });
-	},
-);
+			return API.v1.success({ data });
+		},
+	)
+	.get(
+		'users.getAvatarSuggestion',
+		{
+			authRequired: true,
+			response: {
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+				200: ajv.compile<{
+					suggestions: Record<
+						string,
+						{
+							blob: string;
+							contentType: string;
+							service: string;
+							url: string;
+						}
+					>;
+				}>({
+					type: 'object',
+					properties: {
+						success: {
+							type: 'boolean',
+							enum: [true],
+						},
+						suggestions: {
+							type: 'object',
+							additionalProperties: {
+								type: 'object',
+								properties: {
+									blob: {
+										type: 'string',
+									},
+									contentType: {
+										type: 'string',
+									},
+									service: {
+										type: 'string',
+									},
+									url: {
+										type: 'string',
+										format: 'uri',
+									},
+								},
+								required: ['blob', 'contentType', 'service', 'url'],
+								additionalProperties: false,
+							},
+						},
+					},
+					required: ['success', 'suggestions'],
+					additionalProperties: false,
+				}),
+			},
+		},
+		async function action() {
+			const suggestions = await getAvatarSuggestionForUser(this.user);
+
+			return API.v1.success({ suggestions });
+		},
+	);
 
 API.v1.addRoute(
 	'users.getPreferences',

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

@@ -255,20 +255,6 @@ export type UsersEndpoints = {
 		};
 	};
 
-	'/v1/users.getAvatarSuggestion': {
-		GET: () => {
-			suggestions: Record<
-				string,
-				{
-					blob: string;
-					contentType: string;
-					service: string;
-					url: string;
-				}
-			>;
-		};
-	};
-
 	'/v1/users.checkUsernameAvailability': {
 		GET: (params: { username: string }) => {
 			result: boolean;

yarn.lock

@@ -10437,7 +10437,7 @@ __metadata:
   peerDependencies:
     "@rocket.chat/layout": "*"
     "@rocket.chat/tools": 0.2.4
-    "@rocket.chat/ui-contexts": 27.0.0
+    "@rocket.chat/ui-contexts": 27.0.1
     "@tanstack/react-query": "*"
     react: "*"
     react-hook-form: "*"