Mirrors/Rocket.Chat
1
0
Fork 0
mirror of https://github.com/RocketChat/Rocket.Chat.git synced 2025-12-28 06:47:25 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

feat: Add OpenAPI Support to oauth-apps.list API (#36586)

Browse Source
This commit is contained in:
Ahmed Nasser 2025-08-01 15:09:00 +03:00 committed by GitHub
parent 1a23b725d3
commit 5d7dec3a68
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 51 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.changeset/strange-worms-smoke.md Normal file
View File

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

51
apps/meteor/app/api/server/v1/oauthapps.ts
View File

@ -18,16 +18,49 @@ import { updateOAuthApp } from '../../../oauth2-server-config/server/admin/metho
import type { ExtractRoutesFromAPI } from '../ApiClass';
import { API } from '../api';
API.v1.addRoute(
const oauthAppsListEndpoints = API.v1.get(
'oauth-apps.list',
{ authRequired: true, permissionsRequired: ['manage-oauth-apps'] },
{
async get() {
return API.v1.success({
oauthApps: await OAuthApps.find().toArray(),
});
authRequired: true,
query: ajv.compile<{ uid?: string }>({
type: 'object',
properties: {
uid: {
type: 'string',
},
},
additionalProperties: false,
}),
permissionsRequired: ['manage-oauth-apps'],
response: {
400: validateBadRequestErrorResponse,
401: validateUnauthorizedErrorResponse,
403: validateForbiddenErrorResponse,
200: ajv.compile<{ oauthApps: IOAuthApps[] }>({
type: 'object',
properties: {
oauthApps: {
type: 'array',
items: {
$ref: '#/components/schemas/IOAuthApps',
},
},
success: {
type: 'boolean',
enum: [true],
},
},
required: ['oauthApps', 'success'],
additionalProperties: false,
}),
},
},
async function action() {
return API.v1.success({
oauthApps: await OAuthApps.find().toArray(),
});
},
);
API.v1.addRoute(
@ -152,9 +185,13 @@ const oauthAppsCreateEndpoints = API.v1.post(
type OauthAppsCreateEndpoints = ExtractRoutesFromAPI<typeof oauthAppsCreateEndpoints>;
export type OAuthAppsEndpoints = OauthAppsCreateEndpoints;
type OauthAppsListEndpoints = ExtractRoutesFromAPI<typeof oauthAppsListEndpoints>;
export type OAuthAppsEndpoints = OauthAppsCreateEndpoints | OauthAppsListEndpoints;
declare module '@rocket.chat/rest-typings' {
// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
interface Endpoints extends OauthAppsCreateEndpoints {}
// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
interface Endpoints extends OauthAppsListEndpoints {}
}

8
packages/rest-typings/src/v1/oauthapps.ts
View File

@ -1,16 +1,10 @@
import type { IOAuthApps, IUser } from '@rocket.chat/core-typings';
import type { IOAuthApps } from '@rocket.chat/core-typings';
import type { DeleteOAuthAppParams } from './oauthapps/DeleteOAuthAppParamsDELETE';
import type { OauthAppsGetParams } from './oauthapps/OAuthAppsGetParamsGET';
import type { UpdateOAuthAppParams } from './oauthapps/UpdateOAuthAppParamsPOST';
export type OAuthAppsEndpoint = {
'/v1/oauth-apps.list': {
GET: (params: { uid: IUser['_id'] }) => {
oauthApps: IOAuthApps[];
};
};
'/v1/oauth-apps.get': {
GET: (params: OauthAppsGetParams) => {
oauthApp: IOAuthApps;