Skip to content

feat: Add OpenAPI Support to chat.unpinMessage API#36668

Merged
ggazzo merged 4 commits intoRocketChat:developfrom
ahmed-n-abdeltwab:feat/openapi-chat-unPinMessage
Aug 25, 2025
Merged

feat: Add OpenAPI Support to chat.unpinMessage API#36668
ggazzo merged 4 commits intoRocketChat:developfrom
ahmed-n-abdeltwab:feat/openapi-chat-unPinMessage

Conversation

@ahmed-n-abdeltwab
Copy link
Contributor

@ahmed-n-abdeltwab ahmed-n-abdeltwab commented Aug 8, 2025

https://rocketchat.atlassian.net/browse/ARCH-1789

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

Endpoints:

Looking forward to your feedback! 🚀

@dionisio-bot
Copy link
Contributor

dionisio-bot bot commented Aug 8, 2025

Looks like this PR is not ready to merge, because of the following issues:

  • This PR is targeting the wrong base branch. It should target 7.11.0, but it targets 7.10.0

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

@changeset-bot
Copy link

changeset-bot bot commented Aug 8, 2025

🦋 Changeset detected

Latest commit: 6e0c43b

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

This PR includes changesets to release 39 packages
Name Type
@rocket.chat/meteor Patch
@rocket.chat/rest-typings Patch
@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 Patch
@rocket.chat/web-ui-registration Patch
@rocket.chat/account-service Patch
@rocket.chat/authorization-service Patch
@rocket.chat/ddp-streamer Patch
@rocket.chat/stream-hub-service 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/network-broker 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/omni-core-ee Patch
@rocket.chat/uikit-playground Patch
@rocket.chat/fuselage-ui-kit Patch
@rocket.chat/gazzodown Patch
@rocket.chat/ui-avatar Patch
@rocket.chat/ui-client Patch
@rocket.chat/ui-video-conf Patch
@rocket.chat/ui-voip Patch
@rocket.chat/core-typings Patch
@rocket.chat/apps Patch
@rocket.chat/freeswitch 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

@ahmed-n-abdeltwab ahmed-n-abdeltwab changed the title Feat/openapi chat un pin message feat: Add OpenAPI Support to chat.unpinMessage API Aug 8, 2025
@ahmed-n-abdeltwab ahmed-n-abdeltwab marked this pull request as ready for review August 8, 2025 13:37
@ahmed-n-abdeltwab ahmed-n-abdeltwab requested review from a team as code owners August 8, 2025 13:37
@ahmed-n-abdeltwab
Copy link
Contributor Author

@cardoso Ready for review whenever you have time

@ahmed-n-abdeltwab
Copy link
Contributor Author

Hi @cardoso, feel free to review whenever you have time

@ggazzo ggazzo added this to the 7.11.0 milestone Aug 25, 2025
@ggazzo ggazzo added the stat: QA assured Means it has been tested and approved by a company insider label Aug 25, 2025
@dionisio-bot dionisio-bot bot added the stat: ready to merge PR tested and approved waiting for merge label Aug 25, 2025
@ggazzo ggazzo merged commit 80fbb2e into RocketChat:develop Aug 25, 2025
48 checks passed
@ahmed-n-abdeltwab
Copy link
Contributor Author

thanks

@ahmed-n-abdeltwab ahmed-n-abdeltwab deleted the feat/openapi-chat-unPinMessage branch February 16, 2026 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stat: QA assured Means it has been tested and approved by a company insider stat: ready to merge PR tested and approved waiting for merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants