feat: Add OpenAPI Support to oauth-apps.update API (#36585)

Co-authored-by: Matheus Cardoso <matheus@cardo.so>

Author: ahmed-n-abdeltwab

.changeset/clever-trees-occur.md

@@ -0,0 +1,6 @@
+---
+"@rocket.chat/meteor": patch
+"@rocket.chat/rest-typings": patch
+---
+
+Add OpenAPI support for the Rocket.Chat oauth-apps.update 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/oauthapps.ts

@@ -2,7 +2,6 @@ import type { IOAuthApps } from '@rocket.chat/core-typings';
 import { OAuthApps } from '@rocket.chat/models';
 import {
 	ajv,
-	isUpdateOAuthAppParams,
 	isOauthAppsGetParams,
 	validateUnauthorizedErrorResponse,
 	validateBadRequestErrorResponse,
@@ -59,6 +58,37 @@ const OauthAppsAddParamsSchema = {
 
 const isOauthAppsAddParams = ajv.compile<OauthAppsAddParams>(OauthAppsAddParamsSchema);
 
+type UpdateOAuthAppParams = {
+	appId: string;
+	name: string;
+	active: boolean;
+	clientId?: string | undefined;
+	clientSecret?: string | undefined;
+	redirectUri: string;
+};
+
+const UpdateOAuthAppParamsSchema = {
+	type: 'object',
+	properties: {
+		appId: {
+			type: 'string',
+		},
+		name: {
+			type: 'string',
+		},
+		active: {
+			type: 'boolean',
+		},
+		redirectUri: {
+			type: 'string',
+		},
+	},
+	required: ['appId', 'name', 'active', 'redirectUri'],
+	additionalProperties: false,
+};
+
+const isUpdateOAuthAppParams = ajv.compile<UpdateOAuthAppParams>(UpdateOAuthAppParamsSchema);
+
 const oauthAppsEndpoints = API.v1
 	.get(
 		'oauth-apps.list',
@@ -156,6 +186,38 @@ const oauthAppsEndpoints = API.v1
 
 			return API.v1.success({ application });
 		},
+	)
+	.post(
+		'oauth-apps.update',
+		{
+			authRequired: true,
+			body: isUpdateOAuthAppParams,
+			permissionsRequired: ['manage-oauth-apps'],
+			response: {
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+				403: validateForbiddenErrorResponse,
+				200: ajv.compile<IOAuthApps | null>({
+					allOf: [
+						{ anyOf: [{ $ref: '#/components/schemas/IOAuthApps' }, { type: 'null' }] },
+						{
+							type: 'object',
+							properties: {
+								success: { type: 'boolean', enum: [true] },
+							},
+							required: ['success'],
+						},
+					],
+				}),
+			},
+		},
+		async function action() {
+			const { appId } = this.bodyParams;
+
+			const result = await updateOAuthApp(this.userId, appId, this.bodyParams);
+
+			return API.v1.success(result);
+		},
 	);
 
 API.v1.addRoute(
@@ -185,24 +247,6 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
-	'oauth-apps.update',
-	{
-		authRequired: true,
-		validateParams: isUpdateOAuthAppParams,
-		permissionsRequired: ['manage-oauth-apps'],
-	},
-	{
-		async post() {
-			const { appId } = this.bodyParams;
-
-			const result = await updateOAuthApp(this.userId, appId, this.bodyParams);
-
-			return API.v1.success(result);
-		},
-	},
-);
-
 export type OauthAppsEndpoints = ExtractRoutesFromAPI<typeof oauthAppsEndpoints>;
 
 declare module '@rocket.chat/rest-typings' {

packages/rest-typings/src/index.ts

@@ -235,7 +235,6 @@ export * from './v1/integrations';
 export * from './v1/licenses';
 export * from './v1/omnichannel';
 export * from './v1/oauthapps';
-export * from './v1/oauthapps/UpdateOAuthAppParamsPOST';
 export * from './v1/oauthapps/OAuthAppsGetParamsGET';
 export * from './helpers/PaginatedRequest';
 export * from './helpers/PaginatedResult';

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

@@ -1,16 +1,11 @@
 import type { IOAuthApps } from '@rocket.chat/core-typings';
 
 import type { OauthAppsGetParams } from './oauthapps/OAuthAppsGetParamsGET';
-import type { UpdateOAuthAppParams } from './oauthapps/UpdateOAuthAppParamsPOST';
 
 export type OAuthAppsEndpoint = {
 	'/v1/oauth-apps.get': {
 		GET: (params: OauthAppsGetParams) => {
 			oauthApp: IOAuthApps;
 		};
 	};
-
-	'/v1/oauth-apps.update': {
-		POST: (params: UpdateOAuthAppParams) => IOAuthApps | null;
-	};
 };