chore: Add OpenAPI Support to e2e.getUsersOfRoomWithoutKey API

Merged
AH
7mo ago
+92-64

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:

Get Users of Room Without E2E key

Looking forward to your feedback! 🚀

Summary by CodeRabbit

  • New Features

    • Added OpenAPI support for e2e endpoints to improve API documentation and response validation.

  • Refactor

    • Modernized route definitions and reorganized endpoint handling for clarity and maintainability.
    • Improved request/response validation to strengthen type safety.

  • Chores

    • Bumped patch version metadata in release documentation.

  • Breaking Changes

    • Adjusted public typings surface for e2e endpoints (some exported typing modules were removed).

COMM-144