Skip to content

feat: Add OpenAPI Support to channels.list / channels.list.joined API#5

Draft
ahmed-n-abdeltwab wants to merge 16 commits intofeat/openapi-channels-createfrom
feat/openapi-channels-info
Draft

feat: Add OpenAPI Support to channels.list / channels.list.joined API#5
ahmed-n-abdeltwab wants to merge 16 commits intofeat/openapi-channels-createfrom
feat/openapi-channels-info

Conversation

@ahmed-n-abdeltwab
Copy link
Copy Markdown
Owner

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 RocketChat#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! 🚀

@ahmed-n-abdeltwab ahmed-n-abdeltwab self-assigned this Aug 12, 2025
@github-actions
Copy link
Copy Markdown

PR Preview Action v1.6.2

🚀 View preview at
https://ahmed-n-abdeltwab.github.io/Rocket.Chat/pr-preview/pr-5/

Built to branch gh-pages at 2025-08-12 16:58 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@ahmed-n-abdeltwab ahmed-n-abdeltwab force-pushed the feat/openapi-channels-create branch from ae97d67 to af01a78 Compare August 13, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant