snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)
Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Code scanning - action / CodeQL-Build (push) Failing after 2s
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Code scanning - action / CodeQL-Build (push) Failing after 2s
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
This commit is contained in:
28
apps/meteor/server/api/default/info.ts
Normal file
28
apps/meteor/server/api/default/info.ts
Normal file
@@ -0,0 +1,28 @@
|
||||
import type { IWorkspaceInfo } from '@rocket.chat/core-typings';
|
||||
import { ajv } from '@rocket.chat/rest-typings';
|
||||
|
||||
import { API } from '../api';
|
||||
import { getServerInfo } from '../lib/getServerInfo';
|
||||
|
||||
const infoResponseSchema = ajv.compile<IWorkspaceInfo>({
|
||||
type: 'object',
|
||||
properties: {
|
||||
version: { type: 'string' },
|
||||
success: { type: 'boolean', enum: [true] },
|
||||
},
|
||||
required: ['success'],
|
||||
additionalProperties: true,
|
||||
});
|
||||
|
||||
API.default.get(
|
||||
'info',
|
||||
{
|
||||
authRequired: false,
|
||||
response: {
|
||||
200: infoResponseSchema,
|
||||
},
|
||||
},
|
||||
async function action() {
|
||||
return API.v1.success(await getServerInfo(this.userId));
|
||||
},
|
||||
);
|
||||
115
apps/meteor/server/api/default/openApi.ts
Normal file
115
apps/meteor/server/api/default/openApi.ts
Normal file
@@ -0,0 +1,115 @@
|
||||
import { schemas } from '@rocket.chat/core-typings';
|
||||
import type { Route } from '@rocket.chat/http-router';
|
||||
import { ajv, isOpenAPIJSONEndpoint } from '@rocket.chat/rest-typings';
|
||||
import express from 'express';
|
||||
import { WebApp } from 'meteor/webapp';
|
||||
import swaggerUi from 'swagger-ui-express';
|
||||
|
||||
import { settings } from '../../settings';
|
||||
import { API } from '../api';
|
||||
import { getTrimmedServerVersion } from '../lib/getTrimmedServerVersion';
|
||||
|
||||
const app = express();
|
||||
|
||||
const getTypedRoutes = (
|
||||
typedRoutes: Record<string, Record<string, Route>>,
|
||||
{ withUndocumented = false }: { withUndocumented?: boolean } = {},
|
||||
): Record<string, Record<string, Route>> => {
|
||||
if (withUndocumented) {
|
||||
return typedRoutes;
|
||||
}
|
||||
|
||||
return Object.entries(typedRoutes).reduce(
|
||||
(acc, [path, methods]) => {
|
||||
const filteredMethods = Object.entries(methods)
|
||||
.filter(([_, options]) => !options?.tags?.includes('Missing Documentation'))
|
||||
.reduce(
|
||||
(acc, [method, options]) => {
|
||||
acc[method] = options;
|
||||
return acc;
|
||||
},
|
||||
{} as Record<string, Route>,
|
||||
);
|
||||
|
||||
if (Object.keys(filteredMethods).length > 0) {
|
||||
acc[path] = filteredMethods;
|
||||
}
|
||||
|
||||
return acc;
|
||||
},
|
||||
{} as Record<string, Record<string, Route>>,
|
||||
);
|
||||
};
|
||||
|
||||
const makeOpenAPIResponse = (paths: Record<string, Record<string, Route>>) => ({
|
||||
openapi: '3.0.3',
|
||||
info: {
|
||||
title: 'Rocket.Chat API',
|
||||
description: 'Rocket.Chat API',
|
||||
version: getTrimmedServerVersion(),
|
||||
},
|
||||
servers: [
|
||||
{
|
||||
url: settings.get('Site_Url'),
|
||||
},
|
||||
],
|
||||
components: {
|
||||
securitySchemes: {
|
||||
userId: {
|
||||
type: 'apiKey',
|
||||
in: 'header',
|
||||
name: 'X-User-Id',
|
||||
},
|
||||
authToken: {
|
||||
type: 'apiKey',
|
||||
in: 'header',
|
||||
name: 'X-Auth-Token',
|
||||
},
|
||||
},
|
||||
schemas: schemas.components.schemas,
|
||||
},
|
||||
schemas: schemas.components.schemas,
|
||||
paths,
|
||||
});
|
||||
|
||||
const openApiResponseSchema = ajv.compile<Record<string, unknown>>({
|
||||
type: 'object',
|
||||
properties: {
|
||||
openapi: { type: 'string' },
|
||||
info: { type: 'object' },
|
||||
servers: { type: 'array' },
|
||||
components: { type: 'object' },
|
||||
paths: { type: 'object' },
|
||||
schemas: { type: 'object' },
|
||||
success: { type: 'boolean', enum: [true] },
|
||||
},
|
||||
required: ['openapi', 'info', 'paths', 'success'],
|
||||
additionalProperties: false,
|
||||
});
|
||||
|
||||
API.default.get(
|
||||
'docs/json',
|
||||
{
|
||||
authRequired: false,
|
||||
query: isOpenAPIJSONEndpoint,
|
||||
response: {
|
||||
200: openApiResponseSchema,
|
||||
},
|
||||
},
|
||||
function action() {
|
||||
const { withUndocumented = false } = this.queryParams;
|
||||
|
||||
return API.default.success(makeOpenAPIResponse(getTypedRoutes(API.api.typedRoutes, { withUndocumented })));
|
||||
},
|
||||
);
|
||||
|
||||
app.use(
|
||||
'/api-docs',
|
||||
swaggerUi.serve,
|
||||
swaggerUi.setup(null, {
|
||||
swaggerOptions: {
|
||||
url: `${settings.get('Site_Url')}/api/docs/json`,
|
||||
},
|
||||
}),
|
||||
);
|
||||
WebApp.connectHandlers.use(app);
|
||||
Reference in New Issue
Block a user