chore: Add OpenAPI support for the Rocket.Chat e2e.updateGroupKey endpoints by ahmed-n-abdeltwab · Pull Request #39094 · RocketChat/Rocket.Chat

ahmed-n-abdeltwab · 2026-02-26T15:01:04Z

Description:
This PR integrates OpenAPI support into the Rocket.Chat API, migrate of Rocket.Chat API endpoints to the new OpenAPI pattern. The update includes improved API documentation, enhanced type safety, and response validation using AJV.

Key Changes:

Implemented the new pattern and added AJV-based JSON schema validation for API.
Uses the ExtractRoutesFromAPI utility from the TypeScript definitions to dynamically derive the routes from the endpoint specifications.
Enabled Swagger UI integration for this API.
Route Methods Chaining for the endpoints.
This does not introduce any breaking changes to the endpoint logic.

Issue Reference:
Relates to #34983, part of the ongoing OpenAPI integration effort.

Testing:

Verified that the API response schemas are correctly documented in Swagger UI.
All tests passed without any breaking changes

Looking forward to your feedback! 🚀

Task: ARCH-2012
COMM-144

Summary by CodeRabbit

New Features
- Added OpenAPI documentation and standardized validation for the e2e.updateGroupKey endpoint, improving API documentation and type-safe response handling.
Refactor
- Consolidated e2e endpoint validation schemas for improved consistency across endpoints.

…points - 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.

dionisio-bot · 2026-02-26T15:01:09Z

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

changeset-bot · 2026-02-26T15:01:12Z

🦋 Changeset detected

Latest commit: e1cb845

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 41 packages

Name	Type
@rocket.chat/rest-typings	Minor
@rocket.chat/meteor	Minor
@rocket.chat/api-client	Patch
@rocket.chat/core-services	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/http-router	Patch
@rocket.chat/models	Patch
@rocket.chat/ui-contexts	Major
@rocket.chat/web-ui-registration	Major
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/federation-matrix	Patch
@rocket.chat/omnichannel-services	Patch
@rocket.chat/presence	Patch
rocketchat-services	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/abac	Patch
@rocket.chat/network-broker	Patch
@rocket.chat/omni-core-ee	Patch
@rocket.chat/livechat	Patch
@rocket.chat/mock-providers	Patch
@rocket.chat/cron	Patch
@rocket.chat/instance-status	Patch
@rocket.chat/omni-core	Patch
@rocket.chat/server-fetch	Patch
@rocket.chat/ui-client	Major
@rocket.chat/media-calls	Patch
@rocket.chat/uikit-playground	Patch
@rocket.chat/fuselage-ui-kit	Major
@rocket.chat/gazzodown	Major
@rocket.chat/ui-avatar	Major
@rocket.chat/ui-video-conf	Major
@rocket.chat/ui-voip	Major
@rocket.chat/core-typings	Minor
@rocket.chat/apps	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/license	Patch
@rocket.chat/pdf-worker	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2026-02-26T15:01:13Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f6b887 and e1cb845.

📒 Files selected for processing (5)

.changeset/pretty-jobs-juggle.md
apps/meteor/app/api/server/v1/e2e.ts
packages/rest-typings/src/index.ts
packages/rest-typings/src/v1/e2e.ts
packages/rest-typings/src/v1/e2e/e2eUpdateGroupKeyParamsPOST.ts

Walkthrough

This pull request migrates the e2e.updateGroupKey endpoint from a separate, publicly exported definition pattern to a localized implementation using the new OpenAPI-supported chained route syntax. Types, schemas, and validators are consolidated locally within the main API file, with corresponding public exports removed from the rest-typings package.

Changes

Cohort / File(s)	Summary
Changeset Documentation `.changeset/pretty-jobs-juggle.md`	New changeset documenting minor version bumps and introduction of OpenAPI support for e2e.updateGroupKey endpoints with chained route syntax and shared AJV schemas.
E2E Endpoint Migration `apps/meteor/app/api/server/v1/e2e.ts`	Replaced old OpenAPI block and separate route definition with new chained route syntax. Moved `e2eUpdateGroupKeyParamsPOST` type, schema, and AJV validator from rest-typings into this file as local definitions. Updated route to use consistent validation and response handling patterns.
Rest-Typings Package Cleanup `packages/rest-typings/src/index.ts`, `packages/rest-typings/src/v1/e2e.ts`, `packages/rest-typings/src/v1/e2e/e2eUpdateGroupKeyParamsPOST.ts`	Removed public exports and definitions for e2e.updateGroupKey: deleted `e2eUpdateGroupKeyParamsPOST` type file, removed schema and validator from e2e.ts type mappings, and removed re-export from main index.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

type: chore

Warning

Tools execution failed with the following error:

Failed to run tools: 14 UNAVAILABLE: read ECONNRESET

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2026-02-26T15:15:08Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.68%. Comparing base (29d2454) to head (fb0f3d2).
⚠️ Report is 14 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #39094      +/-   ##
===========================================
+ Coverage    70.66%   70.68%   +0.01%     
===========================================
  Files         3190     3191       +1     
  Lines       112732   112968     +236     
  Branches     20418    20511      +93     
===========================================
+ Hits         79666    79853     +187     
- Misses       31016    31071      +55     
+ Partials      2050     2044       -6

Flag	Coverage Δ
e2e	`60.36% <ø> (-0.03%)`	⬇️
e2e-api	`47.91% <ø> (+0.12%)`	⬆️
unit	`71.30% <ø> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ahmed-n-abdeltwab · 2026-02-27T15:30:16Z

@ggazzo 👍

ggazzo · 2026-02-27T15:32:47Z

/jira ARCH-1935

cubic-dev-ai

No issues found across 5 files

chore: Add OpenAPI support for the Rocket.Chat e2e.updateGroupKey end…

fb0f3d2

…points - 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.

ahmed-n-abdeltwab mentioned this pull request Feb 26, 2026

[NOMERGE] feat: openapi migration progress RocketChat/Rocket.Chat-Open-API#150

Draft

ahmed-n-abdeltwab marked this pull request as ready for review February 27, 2026 15:30

ahmed-n-abdeltwab requested review from a team as code owners February 27, 2026 15:30

ggazzo added this to the 8.3.0 milestone Feb 27, 2026

Update pretty-jobs-juggle.md

e1cb845

ggazzo added the stat: QA assured Means it has been tested and approved by a company insider label Feb 27, 2026

dionisio-bot bot added the stat: ready to merge PR tested and approved waiting for merge label Feb 27, 2026

ggazzo merged commit 2a27010 into RocketChat:develop Feb 27, 2026
6 checks passed

coderabbitai bot added the type: chore label Feb 27, 2026

cubic-dev-ai bot reviewed Feb 27, 2026

View reviewed changes

ahmed-n-abdeltwab deleted the chore/openapi-e2e-updateGroupKey branch February 27, 2026 15:39

coderabbitai bot mentioned this pull request Mar 2, 2026

chore: Add OpenAPI support for the Rocket.Chat e2e endpoints #39219

Merged

5 tasks

rocketchat-github-ci mentioned this pull request Mar 3, 2026

Release 8.3.0 #39275

Closed

AliNunes added the community label Mar 5, 2026

ahmed-n-abdeltwab mentioned this pull request Mar 7, 2026

chore: migrate rooms.muteUser and rooms.unmuteUser endpoints to the new pattern #39414

Open

rocketchat-github-ci mentioned this pull request Mar 20, 2026

Release 8.3.0 #39778

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

chore: Add OpenAPI support for the Rocket.Chat e2e.updateGroupKey endpoints#39094
ggazzo merged 2 commits intoRocketChat:developfrom
ahmed-n-abdeltwab:chore/openapi-e2e-updateGroupKey

ahmed-n-abdeltwab commented Feb 26, 2026 •

edited by atlassian bot

Loading

Uh oh!

dionisio-bot bot commented Feb 26, 2026 •

edited

Loading

Uh oh!

changeset-bot bot commented Feb 26, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Feb 26, 2026 •

edited

Loading

Review failed

Uh oh!

codecov bot commented Feb 26, 2026 •

edited

Loading

Uh oh!

ahmed-n-abdeltwab commented Feb 27, 2026

Uh oh!

Uh oh!

ggazzo commented Feb 27, 2026

Uh oh!

cubic-dev-ai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ahmed-n-abdeltwab commented Feb 26, 2026 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

dionisio-bot bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Suggested labels

Uh oh!

codecov bot commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ahmed-n-abdeltwab commented Feb 27, 2026

Uh oh!

Uh oh!

ggazzo commented Feb 27, 2026

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ahmed-n-abdeltwab commented Feb 26, 2026 •

edited by atlassian bot

Loading

dionisio-bot bot commented Feb 26, 2026 •

edited

Loading

changeset-bot bot commented Feb 26, 2026 •

edited

Loading

coderabbitai bot commented Feb 26, 2026 •

edited

Loading

codecov bot commented Feb 26, 2026 •

edited

Loading