chore: Add OpenAPI support for the Rocket.Chat e2e.updateGroupKey endpoints (#39094)

Co-authored-by: Guilherme Gazzo <guilhermegazzo@gmail.com>

Author: ahmed-n-abdeltwab

.changeset/pretty-jobs-juggle.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/rest-typings': minor
+'@rocket.chat/meteor': minor
+---
+
+Adds OpenAPI support for the Rocket.Chat e2e.updateGroupKey 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/e2e.ts

@@ -5,7 +5,6 @@ import {
 	validateUnauthorizedErrorResponse,
 	validateBadRequestErrorResponse,
 	ise2eSetUserPublicAndPrivateKeysParamsPOST,
-	ise2eUpdateGroupKeyParamsPOST,
 	isE2EProvideUsersGroupKeyProps,
 	isE2EFetchUsersWaitingForGroupKeyProps,
 	isE2EResetRoomKeyProps,
@@ -38,6 +37,12 @@ type e2eGetUsersOfRoomWithoutKeyParamsGET = {
 	rid: string;
 };
 
+type e2eUpdateGroupKeyParamsPOST = {
+	uid: string;
+	rid: string;
+	key: string;
+};
+
 const E2eSetRoomKeyIdSchema = {
 	type: 'object',
 	properties: {
@@ -63,12 +68,31 @@ const e2eGetUsersOfRoomWithoutKeyParamsGETSchema = {
 	required: ['rid'],
 };
 
+const e2eUpdateGroupKeyParamsPOSTSchema = {
+	type: 'object',
+	properties: {
+		uid: {
+			type: 'string',
+		},
+		rid: {
+			type: 'string',
+		},
+		key: {
+			type: 'string',
+		},
+	},
+	additionalProperties: false,
+	required: ['uid', 'rid', 'key'],
+};
+
 const isE2eSetRoomKeyIdProps = ajv.compile<E2eSetRoomKeyIdProps>(E2eSetRoomKeyIdSchema);
 
 const ise2eGetUsersOfRoomWithoutKeyParamsGET = ajv.compile<e2eGetUsersOfRoomWithoutKeyParamsGET>(
 	e2eGetUsersOfRoomWithoutKeyParamsGETSchema,
 );
 
+const ise2eUpdateGroupKeyParamsPOST = ajv.compile<e2eUpdateGroupKeyParamsPOST>(e2eUpdateGroupKeyParamsPOSTSchema);
+
 const e2eEndpoints = API.v1
 	.post(
 		'e2e.setRoomKeyID',
@@ -165,6 +189,31 @@ const e2eEndpoints = API.v1
 
 			return API.v1.success(result);
 		},
+	)
+	.post(
+		'e2e.updateGroupKey',
+		{
+			authRequired: true,
+			body: ise2eUpdateGroupKeyParamsPOST,
+			response: {
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+				200: ajv.compile<void>({
+					type: 'object',
+					properties: {
+						success: { type: 'boolean', enum: [true] },
+					},
+					required: ['success'],
+				}),
+			},
+		},
+		async function action() {
+			const { uid, rid, key } = this.bodyParams;
+
+			await updateGroupKey(rid, uid, key, this.userId);
+
+			return API.v1.success();
+		},
 	);
 
 /**
@@ -222,56 +271,6 @@ API.v1.addRoute(
 	},
 );
 
-/**
- * @openapi
- *  /api/v1/e2e.updateGroupKey:
- *    post:
- *      description: Updates the end-to-end encryption key for a user on a room
- *      security:
- *        - autenticated: {}
- *      requestBody:
- *        description: A tuple containing the user ID, the room ID, and the key
- *        content:
- *          application/json:
- *            schema:
- *              type: object
- *              properties:
- *                uid:
- *                  type: string
- *                rid:
- *                  type: string
- *                key:
- *                  type: string
- *      responses:
- *        200:
- *          content:
- *            application/json:
- *              schema:
- *                $ref: '#/components/schemas/ApiSuccessV1'
- *        default:
- *          description: Unexpected error
- *          content:
- *            application/json:
- *              schema:
- *                $ref: '#/components/schemas/ApiFailureV1'
- */
-API.v1.addRoute(
-	'e2e.updateGroupKey',
-	{
-		authRequired: true,
-		validateParams: ise2eUpdateGroupKeyParamsPOST,
-	},
-	{
-		async post() {
-			const { uid, rid, key } = this.bodyParams;
-
-			await updateGroupKey(rid, uid, key, this.userId);
-
-			return API.v1.success();
-		},
-	},
-);
-
 API.v1.addRoute(
 	'e2e.acceptSuggestedGroupKey',
 	{

packages/rest-typings/src/index.ts

@@ -244,7 +244,6 @@ export * from './v1/server-events';
 export * from './v1/autotranslate/AutotranslateGetSupportedLanguagesParamsGET';
 export * from './v1/autotranslate/AutotranslateSaveSettingsParamsPOST';
 export * from './v1/e2e/e2eSetUserPublicAndPrivateKeysParamsPOST';
-export * from './v1/e2e/e2eUpdateGroupKeyParamsPOST';
 export * from './v1/e2e';
 export * from './v1/import';
 export * from './v1/email-inbox';

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

@@ -39,31 +39,6 @@ const E2eGetUsersOfRoomWithoutKeySchema = {
 
 export const isE2eGetUsersOfRoomWithoutKeyProps = ajv.compile<E2eGetUsersOfRoomWithoutKeyProps>(E2eGetUsersOfRoomWithoutKeySchema);
 
-type E2eUpdateGroupKeyProps = {
-	uid: string;
-	rid: string;
-	key: string;
-};
-
-const E2eUpdateGroupKeySchema = {
-	type: 'object',
-	properties: {
-		uid: {
-			type: 'string',
-		},
-		rid: {
-			type: 'string',
-		},
-		key: {
-			type: 'string',
-		},
-	},
-	required: ['uid', 'rid', 'key'],
-	additionalProperties: false,
-};
-
-export const isE2eUpdateGroupKeyProps = ajv.compile<E2eUpdateGroupKeyProps>(E2eUpdateGroupKeySchema);
-
 type E2EProvideUsersGroupKeyProps = {
 	usersSuggestedGroupKeys: Record<IRoom['_id'], { _id: IUser['_id']; key: string; oldKeys: ISubscription['suggestedOldRoomKeys'] }[]>;
 };
@@ -149,9 +124,6 @@ export type E2eEndpoints = {
 	'/v1/e2e.setUserPublicAndPrivateKeys': {
 		POST: (params: E2eSetUserPublicAndPrivateKeysProps) => void;
 	};
-	'/v1/e2e.updateGroupKey': {
-		POST: (params: E2eUpdateGroupKeyProps) => void;
-	};
 	'/v1/e2e.acceptSuggestedGroupKey': {
 		POST: (params: E2eGetUsersOfRoomWithoutKeyProps) => void;
 	};